Installation
============

Malevich Nova is distributed as a part of Malevich OS.

Prerequisites
-------------

- Python 3.10 or higher
- ``uv`` package manager. See `uv installation guide <https://docs.astral.sh/uv/getting-started/installation/>`_ for instructions.

Installation Methods
--------------------

Using in Other Projects
^^^^^^^^^^^^^^^^^^^^^^^

To install the package in another project, you should have access to the `MalevichOS Github repository <https://github.com/malevichai/malevichos>`_.

Using just Github
~~~~~~~~~~~~~~~~~~

To add the package to your project, you can use the following command:

.. code-block:: bash

    uv add git+https://github.com/malevichai/malevichos#subdirectory=malevich-nova

Or install the package without adding it to the dependencies:

.. code-block:: bash

    uv pip install git+https://github.com/malevichai/malevichos#subdirectory=malevich-nova

Using a GitHub Personal Access Token (PAT)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

You will need a GitHub Personal Access Token (PAT) with access to the repository. Replace ``<PAT>`` in the command below with your actual token:

.. code-block:: bash

    uv add git+https://<PAT>@github.com/malevichai/malevichos#subdirectory=malevich-nova

.. warning::

    Not recommended as it will write the token to the dependency lock file.

**How to get a PAT:**

1. Go to `GitHub Settings > Developer settings > Personal access tokens <https://github.com/settings/tokens>`_.
2. Click "Generate new token" and select the appropriate scopes (at least ``repo`` access).
3. Copy the generated token and use it in the command above.

Development Installation
^^^^^^^^^^^^^^^^^^^^^^^^^

To install the package for development, you should clone the repository and install the package from the local source:

.. code-block:: bash

    git clone https://github.com/malevichai/malevichos /path/to/malevichos
    uv pip install -e /path/to/malevichos/malevich-nova # Editable install to allow for development