Python BO4E ORM

At this point this repository serves only as an exemplary implementation of a BO4E ORM. The main work (i.e. the generation of SQL Model code) will be done in the BO4E-CLI-Tool

A ORM tool to map between SQL databases and BO4E classes using:

• SQLModel (https://sqlmodel.tiangolo.com) for the ORM
• BO4E-Schema-Tool (https://pypi.org/project/BO4E-Schema-Tool) to pull and modify an existing BO4E version
• BO4E-Python-Generator (https://pypi.org/project/BO4E-Python-Generator) to generate SQLModel classes from the BO4E schema
• Docker Container (https://www.docker.com) to create the database with
• PostgreSQL (https://www.postgresql.org) (- In principle, Alembic (https://alembic.sqlalchemy.org) is supported for migrations, but not further supported at the moment)

The idea of this tool is to provide a first instance of an ORM which has been generated from a specific BO4E version. For further information of the functionalities of this ORM framework, please refer to the documentation of SQLModel. Please note that this is a very early version of the ORM and might not be fully functional yet.

Installation

It will also be available on pypi.

pip install borm

Description

First, install the dev dependencies with uv:

uv sync --group dev

To setup a test db (postgresql), run the following from the src directory:

uv run python -m borm.db.postgresql_db.create_env_file
docker compose -f borm/db/postgresql_db/docker-compose.yaml up -d

Make sure that your local host is running.

Alternatively, an existing bo4e version can be pulled via (from a bo4e_schemas directory):

uv run bost -t v202401.0.1 -o ./
uv run bo4e-generator -i ./ -o ../src/borm/models -ot sql_model

This uses two other tools: https://github.com/bo4e/BO4E-Schema-Tool and https://github.com/bo4e/BO4E-Python-Generator

Make sure you specify the version via the -t flag.

Enter the following (from src/borm/db/postgresql_db) to delete the test db:

docker compose -f docker-compose.yaml down -v

In order to get a better understanding how this ORM works, you might want to have a look at the tests in the tests folder.

In principle, alembic migrations are supported, e.g. by running (from src/borm/db/postgresql_db):

uv run alembic upgrade head

However, this is not further supported at the moment.

Contribute

You are very welcome to contribute to this repository by opening a pull request against the main branch. If you use a Windows OS, you might need to change psycopg -> psycopg[binary] in pyproject.toml.