bi-sc-client

This library is a Python wrapper for accessing Som Connexió BI API.

Operations

• Start billing with a Billing Run number
• Notify the BI API with an invoice number

Installation

$ pip install bi-sc-client

Configuration Environment

To use this library you must expose the needed environment variables:

BI_URL:
BI_USER:
BI_PASSWORD:

These environment variables are needed to locate and access to the BI API.

Usage

• Start billing with a Billing Run number

    billing_run_uuid = 1234
    BISomConnexioClient().start_billing_run_invoicing(
        billing_run_number=billing_run_uuid,
    )

• Notify the BI API with an invoice number

    invoice_number = "AB-1234Z"
    BISomConnexioClient().notify_invoice_number(
        invoice_number=invoice_number,
    )

Development

Setup environment

1. Install pyenv

curl https://pyenv.run | bash

2. Build the Python version

pyenv install  3.7.13

3. Create a virtualenv

pyenv virtualenv 3.7.13 bi-sc-client

4. Install dependencies

pyenv exec pip install -r requirements.txt

5. Install pre-commit hooks

pyenv exec pre-commit install

Install the package locally in development mode

When we are using this package in other projects, we need to install it to use as import in the other files. Install the package in development mode helps us to modify the package and use the new version in live in the other project.

pip install -e .

Test the HTTP request

We are using the HTTP recording plugin of Pytest: pytest-recording.

With VRC we can catch the HTTP responses and then, execute the tests using them.

To add a new test:

• Expose the needed envvars. Look for them at the Configuration Environment section
• Execute the tests using pytest command:
• If you are writing a new test that is making requests, you should run:

$ pytest --record-mode=once path/to/your/test

• You might need to record requests for an specific tests. In that case make sure to only run the tests affected and run

$ pytest --record-mode=rewrite path/to/your/test

• Add the new cassetes to the commit and push them.
• The CI uses the cassetes to emulate the HTTP response in the test.

Run test suite

$ tox

Formatting

We use Black as formatter. First to commit, tun the black command:

$ black .
All done! ✨ 🍰 ✨
29 files left unchanged.

Darker

Black is a great formatter, but to mantain your code without execute the black command avery time, you can configure your IDE to use darker to format only the changed or added code when you save the file.

Release process

Update CHANGELOG.md following this steps:

1. Add any entries missing from merged merge requests.
2. Duplicate the [Unreleased] header.
3. Replace the second Unreleased with a version number followed by the current date. Copy the exact format from previous releases.

Then, you can release and publish the package to PyPi:

1. Update the __version__ var in __init__.py matching the version you specified in the CHANGELOG.
2. Open a merge request with these changes for the team to approve
3. Merge it, add a git tag on that merge commit and push it.
4. Once the pipeline has successfully passed, your package had been published.