OBP Accounting SDK

Description

Python SDK for the OBP Accounting Service.

Usage

The API provides the following main classes to be used asynchronously:

• obp_accounting_sdk.AsyncAccountingSessionFactory
• obp_accounting_sdk.AsyncOneshotSession

and the corresponding synchronous versions:

• obp_accounting_sdk.AccountingSessionFactory
• obp_accounting_sdk.OneshotSession

The factory class must be instantiated only once, and a new session can be obtained by calling the oneshot_session method used as a context manager:

subtype: ServiceSubtype = ...
proj_id: UUID = ...
user_id: UUID = ...
name: str | None = ...
estimated_count: int = ...
async with accounting_session_factory.oneshot_session(
    subtype=subtype,
    proj_id=proj_id,
    user_id=user_id,
    name=name,
    count=estimated_count,
) as acc_session:
    # actual logic
    acc_session.count = actual_count
    acc_session.name = actual_name

In the example above:

• The reservation with the accounting service happens when entering the context manager.
• The usage is sent to the accounting service when exiting the context manager, unless an exception is raised, because in this case we suppose that the actual business logic to be charged didn't get executed.
• The value of estimated_count is used for reservation, and it's used also for usage unless a new value is assigned to acc_session.count.

Accounting session can be also used without the context manager:

subtype: ServiceSubtype = ...
proj_id: UUID = ...
user_id: UUID = ...
name: str | None = ...
estimated_instances: int = ...
instance_type: str = ...
instances: int = ...
duration: int = ...
acc_session = accounting_session_factory.longrun_session(
    subtype=subtype,
    proj_id=proj_id,
    user_id=user_id,
    name=name,
    instance_type="FARGATE",
    instances=1,
    duration=5,
)

await acc_session.make_reservation()
await acc_session.start() # start method is required only for longrun sessions.

# Actual logic

await acc_session.finish()

[!TIP] The integration with the Accounting service can be disabled by setting the env variable ACCOUNTING_DISABLED=1 before initializing the AsyncAccountingSessionFactory or AccountingSessionFactory object.

Example

See the Demo app for a working example integrated in a simple FastAPI app.

If you installed tox, and if you have a running instance of the Accounting service, you can set the required env variables and run the demo with:

export ACCOUNTING_BASE_URL=http://127.0.0.1:8100
export UVICORN_PORT=8000
tox -e demo

and call the endpoint after setting a valid project-id and user-id with:

export PROJECT_ID=8eb248a8-672c-4158-9365-b95286cba796
export USER_ID=7ee00c6c-3f92-4ac0-b49e-9f690f76826e
curl -vs "http://127.0.0.1:$UVICORN_PORT/query" \
-H "content-type: application/json" \
-H "project-id: $PROJECT_ID" \
-H "user-id: $USER_ID" \
--data-binary @- <<EOF
{"input_text": "my query"}
EOF

Contribution Guidelines

See CONTRIBUTING.

Acknowledgment

The development of this software was supported by funding to the Blue Brain Project, a research center of the École polytechnique fédérale de Lausanne (EPFL), from the Swiss government’s ETH Board of the Swiss Federal Institutes of Technology.

For license and authors, see LICENSE and AUTHORS respectively.

Copyright © 2024 Blue Brain Project/EPFL

Copyright © 2025 Open Brain Institute