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

From Codeberg:

.. code-block:: bash

   pip install git+https://codeberg.org/fbxyz/boapi.git

From a local clone (development install):

.. code-block:: bash

   git clone https://codeberg.org/fbxyz/boapi.git
   cd boapi
   pip install -e .

``.env`` configuration
----------------------

Connection credentials are read from ``~/.env`` then the local ``.env`` (the
latter takes precedence). The password must never appear in clear text in the
code.

.. code-block:: ini

   BO_BASE_URL=https://server/biprws
   BO_USER=my_account
   BO_AUTH_TYPE=secEnterprise
   BO_PASSWORD=my_password

   # Per-environment variants: suffix at the end of the key.
   # Selected with env="qualif" / env="prod".
   BO_BASE_URL_QUALIF=https://server-qualif/biprws
   BO_BASE_URL_PROD=https://server-prod/biprws

When an environment is given (``env="prod"``), the suffixed variant
(``BO_BASE_URL_PROD``) is used if present, otherwise the unsuffixed variable.