###############
Developer notes
###############

********
Building
********
You can build and install the package locally with the following::

    rm -rf dist
    python -m build --sdist --wheel --outdir dist/
    pip install dist/im-squonk2-client-*.tar.gz

And uninstall with::

    pip uninstall im-squonk2-client

.. note::
    If you've set ``PYTHONPATH`` (see testing below) you will need to unset it
    (``unset PYTHONPATH``). Otherwise you will get a
    **No files were found to uninstall.** error from ``pip``.

*******
Testing
*******
From a clone of the repository and access to a suitable DM-API deployment user
and project you should be able to run a set of basic API tests with the
``test.py`` module in the project root.

First, you need to provide the test code with a configuration that it expects
via a number of environment variables. These are the Data Manager API,
the Keycloak server, its realm and client and a user's credentials.

.. note::
    The test code relies on a user with administrative capabilities.

.. code-block:: bash

    export SQUONK2_DMAPI_URL='https://example.com/data-manager-api'
    export SQUONK2_DMAPI_URL_VALIDATION='true'
    export SQUONK2_KEYCLOAK_URL='https://example.com/auth'
    export SQUONK2_KEYCLOAK_REALM='squonk2'
    export SQUONK2_KEYCLOAK_DM_CLIENT_ID='data-manager-api-test'
    export SQUONK2_KEYCLOAK_USER='dmit-user-admin'
    export SQUONK2_KEYCLOAK_USER_PASSWORD='blob1234'


With these set you can run the basic tests.

.. code-block:: bash

    export PYTHONPATH=src
    ./test.py
    DM-API connected (https://example.com/data-manager-api)
    [...]
    Done

And here the developer is testing a project that already exists: -

.. code-block:: bash

    export PYTHONPATH=src
    ./test.py -p project-e1ce441e-c4d1-4ad1-9057-1a11dbdccebe
    DM-API connected (https://example.com/data-manager-api)
    [...]
    Done