exobrain-database 0.1.0__tar.gz

exobrain_database-0.1.0/LICENSE.md

@@ -0,0 +1,7 @@
+Copyright © 2025-present DFYA SAS, All rights reserved.
+
+This is a private project.  
+All rights reserved.
+
+The content of this repository is intended for private use only.  
+Reproduction, distribution, or disclosure to third parties, in whole or in part, is strictly prohibited without the explicit written permission of the copyright holder.

exobrain_database-0.1.0/PKG-INFO

@@ -0,0 +1,166 @@
+Metadata-Version: 2.3
+Name: exobrain-database
+Version: 0.1.0
+Summary: Exobrain database model and migration management
+Keywords: 
+Author: Laurent LAPORTE
+Author-email: Laurent LAPORTE <laurent@dfya.io>
+License: Copyright © 2025-present DFYA SAS, All rights reserved.
+         
+         This is a private project.  
+         All rights reserved.
+         
+         The content of this repository is intended for private use only.  
+         Reproduction, distribution, or disclosure to third parties, in whole or in part, is strictly prohibited without the explicit written permission of the copyright holder.
+Classifier: Development Status :: 4 - Beta
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: Database
+Classifier: Topic :: Database :: Database Engines/Servers
+Classifier: License :: Other/Proprietary License
+Requires-Dist: alembic~=1.18.4
+Requires-Dist: psycopg[binary]~=3.3.4
+Requires-Dist: sqlalchemy~=2.0.51
+Requires-Python: >=3.12
+Project-URL: Documentation, https://github.com/MyExobrain/exobrain-database#readme
+Project-URL: Issues, https://github.com/MyExobrain/exobrain-database/issues
+Project-URL: Source, https://github.com/MyExobrain/exobrain-database
+Description-Content-Type: text/markdown
+
+# exobrain-database
+
+[![PyPI - Version](https://img.shields.io/pypi/v/exobrain-database.svg)](https://pypi.org/project/exobrain-database)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/exobrain-database.svg)](https://pypi.org/project/exobrain-database)
+[![CI/CD](https://github.com/MyExobrain/exobrain-database/actions/workflows/build.yml/badge.svg)](https://github.com/MyExobrain/exobrain-database/actions/workflows/build.yml)
+
+---
+
+`exobrain-database` is a Python library that provides the SQLAlchemy ORM models, Alembic migration management,
+and utility tools for the Exobrain platform database. It supports a **multi-tenant architecture** where each
+organization has its own isolated PostgreSQL schema.
+
+The package is distributed as a **namespace package** under `exobrain.database`, making it composable with
+other `exobrain.*` packages.
+
+---
+
+## Table of Contents
+
+- [Installation](#installation)
+- [Development](#development)
+- [Project Structure](#project-structure)
+- [Usage](#usage)
+- [License](#license)
+
+---
+
+## Installation
+
+```console
+pip install exobrain-database
+```
+
+Or with [uv](https://docs.astral.sh/uv/):
+
+```console
+uv add exobrain-database
+```
+
+---
+
+## Development
+
+This project uses [uv](https://docs.astral.sh/uv/) for dependency management and building.
+
+**Prerequisites:** Python 3.12+ and uv
+
+Setup:
+```console
+git clone git@github.com:MyExobrain/exobrain-database.git
+cd exobrain-database
+uv sync --all-groups
+```
+
+Common tasks:
+```console
+uv run pytest                                  # Run tests
+uv run pytest --cov=exobrain.database          # Tests with coverage
+uv run ruff check src tests                    # Lint
+uv run ruff format src tests                   # Format
+uv run mypy src                                # Type check
+uv build                                       # Build wheel + sdist
+```
+
+Add dependencies:
+```console
+uv add package-name                # Production
+uv add --group dev package-name    # Development
+uv sync --upgrade                  # Update all
+```
+
+---
+
+## Project Structure
+
+The source code lives under `src/exobrain/database/` as a namespace package:
+
+```
+src/exobrain/database/
+├── migrations/               # Alembic migration engine
+│   ├── alembic.ini           # Alembic configuration file
+│   ├── env.py                # Migration environment setup
+│   ├── migration_manager.py  # Public API: upgrade / downgrade per org schema
+│   └── versions/             # Auto-generated migration scripts
+├── model/                    # SQLAlchemy ORM models
+│   ├── base.py               # Declarative base classes
+│   ├── associations/         # Many-to-many association tables
+│   ├── enums/                # Database enumeration types (config, currency, running states)
+│   ├── general/              # Cross-organization models (copilots, permissions, roles,
+│   │                         #   predefined actions/executions/risks, reasons)
+│   └── org/                  # Per-organization models (config, connections, dashboards,
+│                             #   running actions/executions/risks, scopes, users)
+└── tools/                    # Reusable database utilities
+    ├── jsonb_filter.py       # Helper for filtering on JSONB columns
+    ├── record_count.py       # Efficient record counting queries
+    └── sql_query_logger.py   # SQLAlchemy query logging utility
+```
+
+### Key design decisions
+
+- **Multi-tenant schemas**: each organization's data is isolated in a dedicated PostgreSQL schema
+  (e.g. `org_<id>`). Migrations are applied per-schema via `migration_manager.upgrade(org_id)`.
+- **Namespace package**: `exobrain.database` has no `__init__.py` at the `exobrain` level, allowing
+  other `exobrain.*` packages to coexist in the same Python environment.
+- **`py.typed` marker**: the package ships type information and is fully typed (compatible with mypy
+  in strict mode).
+- **Build system**: Uses `uv` as the modern Python build & package manager.
+
+---
+
+## Usage
+
+### Apply migrations for an organization
+
+```python
+from uuid import UUID
+from exobrain.database.migrations import migration_manager
+
+org_id = UUID("12345678-1234-5678-1234-567812345678")
+migration_manager.upgrade(org_id)
+```
+
+### Use ORM models
+
+```python
+from exobrain.database.model.general.role import Role
+from exobrain.database.model.org.user import User
+```
+
+---
+
+## License
+
+`exobrain-database` is distributed under a proprietary license. See [LICENSE.md](LICENSE.md) for details.

exobrain_database-0.1.0/README.md

@@ -0,0 +1,134 @@
+# exobrain-database
+
+[![PyPI - Version](https://img.shields.io/pypi/v/exobrain-database.svg)](https://pypi.org/project/exobrain-database)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/exobrain-database.svg)](https://pypi.org/project/exobrain-database)
+[![CI/CD](https://github.com/MyExobrain/exobrain-database/actions/workflows/build.yml/badge.svg)](https://github.com/MyExobrain/exobrain-database/actions/workflows/build.yml)
+
+---
+
+`exobrain-database` is a Python library that provides the SQLAlchemy ORM models, Alembic migration management,
+and utility tools for the Exobrain platform database. It supports a **multi-tenant architecture** where each
+organization has its own isolated PostgreSQL schema.
+
+The package is distributed as a **namespace package** under `exobrain.database`, making it composable with
+other `exobrain.*` packages.
+
+---
+
+## Table of Contents
+
+- [Installation](#installation)
+- [Development](#development)
+- [Project Structure](#project-structure)
+- [Usage](#usage)
+- [License](#license)
+
+---
+
+## Installation
+
+```console
+pip install exobrain-database
+```
+
+Or with [uv](https://docs.astral.sh/uv/):
+
+```console
+uv add exobrain-database
+```
+
+---
+
+## Development
+
+This project uses [uv](https://docs.astral.sh/uv/) for dependency management and building.
+
+**Prerequisites:** Python 3.12+ and uv
+
+Setup:
+```console
+git clone git@github.com:MyExobrain/exobrain-database.git
+cd exobrain-database
+uv sync --all-groups
+```
+
+Common tasks:
+```console
+uv run pytest                                  # Run tests
+uv run pytest --cov=exobrain.database          # Tests with coverage
+uv run ruff check src tests                    # Lint
+uv run ruff format src tests                   # Format
+uv run mypy src                                # Type check
+uv build                                       # Build wheel + sdist
+```
+
+Add dependencies:
+```console
+uv add package-name                # Production
+uv add --group dev package-name    # Development
+uv sync --upgrade                  # Update all
+```
+
+---
+
+## Project Structure
+
+The source code lives under `src/exobrain/database/` as a namespace package:
+
+```
+src/exobrain/database/
+├── migrations/               # Alembic migration engine
+│   ├── alembic.ini           # Alembic configuration file
+│   ├── env.py                # Migration environment setup
+│   ├── migration_manager.py  # Public API: upgrade / downgrade per org schema
+│   └── versions/             # Auto-generated migration scripts
+├── model/                    # SQLAlchemy ORM models
+│   ├── base.py               # Declarative base classes
+│   ├── associations/         # Many-to-many association tables
+│   ├── enums/                # Database enumeration types (config, currency, running states)
+│   ├── general/              # Cross-organization models (copilots, permissions, roles,
+│   │                         #   predefined actions/executions/risks, reasons)
+│   └── org/                  # Per-organization models (config, connections, dashboards,
+│                             #   running actions/executions/risks, scopes, users)
+└── tools/                    # Reusable database utilities
+    ├── jsonb_filter.py       # Helper for filtering on JSONB columns
+    ├── record_count.py       # Efficient record counting queries
+    └── sql_query_logger.py   # SQLAlchemy query logging utility
+```
+
+### Key design decisions
+
+- **Multi-tenant schemas**: each organization's data is isolated in a dedicated PostgreSQL schema
+  (e.g. `org_<id>`). Migrations are applied per-schema via `migration_manager.upgrade(org_id)`.
+- **Namespace package**: `exobrain.database` has no `__init__.py` at the `exobrain` level, allowing
+  other `exobrain.*` packages to coexist in the same Python environment.
+- **`py.typed` marker**: the package ships type information and is fully typed (compatible with mypy
+  in strict mode).
+- **Build system**: Uses `uv` as the modern Python build & package manager.
+
+---
+
+## Usage
+
+### Apply migrations for an organization
+
+```python
+from uuid import UUID
+from exobrain.database.migrations import migration_manager
+
+org_id = UUID("12345678-1234-5678-1234-567812345678")
+migration_manager.upgrade(org_id)
+```
+
+### Use ORM models
+
+```python
+from exobrain.database.model.general.role import Role
+from exobrain.database.model.org.user import User
+```
+
+---
+
+## License
+
+`exobrain-database` is distributed under a proprietary license. See [LICENSE.md](LICENSE.md) for details.

exobrain_database-0.1.0/pyproject.toml

@@ -0,0 +1,115 @@
+[build-system]
+requires = ["uv_build>=0.11.23,<0.12"]
+build-backend = "uv_build"
+
+[project]
+name = "exobrain-database"
+version = "0.1.0"
+description = "Exobrain database model and migration management"
+authors = [
+    { name = "Laurent LAPORTE", email = "laurent@dfya.io" }
+]
+readme = "README.md"
+requires-python = ">=3.12"
+license = { file = "LICENSE.md" }
+keywords = []
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Topic :: Software Development :: Libraries",
+    "Topic :: Database",
+    "Topic :: Database :: Database Engines/Servers",
+    "License :: Other/Proprietary License",
+]
+dependencies = [
+    "alembic~=1.18.4",
+    "psycopg[binary]~=3.3.4",
+    "sqlalchemy~=2.0.51",
+]
+
+[project.urls]
+Documentation = "https://github.com/MyExobrain/exobrain-database#readme"
+Issues = "https://github.com/MyExobrain/exobrain-database/issues"
+Source = "https://github.com/MyExobrain/exobrain-database"
+
+[dependency-groups]
+dev = [
+    "coverage~=7.14.2",
+    "mypy~=2.1.0",
+    "pytest~=9.1.1",
+    "pytest-cov~=7.1.0",
+    "twine~=6.2.0",
+]
+
+# -----------------------------------------------
+# Configuration for "uv" build tool
+# -----------------------------------------------
+
+[tool.uv.build-backend]
+module-name = "exobrain.database"
+
+# -----------------------------------------------
+# Configuration for "coverage" tool (testing coverage)
+# -----------------------------------------------
+
+[tool.coverage.run]
+source_pkgs = ["exobrain.database", "tests"]
+branch = true
+parallel = true
+
+[tool.coverage.paths]
+exobrain_database_model = ["src/exobrain/database", "*/exobrain-database/src/exobrain/database"]
+tests = ["tests", "*/exobrain-database/tests"]
+
+[tool.coverage.report]
+exclude_lines = [
+    "no cov",
+    "if __name__ == .__main__.:",
+    "if TYPE_CHECKING:",
+]
+
+# -----------------------------------------------
+# Configuration for "mypy" static type checker
+# -----------------------------------------------
+
+[tool.mypy]
+python_version = "3.13"
+namespace_packages = true
+explicit_package_bases = true
+mypy_path = "src"
+ignore_missing_imports = true
+strict = true
+exclude = [
+    "src/exobrain/database/migrations/versions",
+]
+
+# -----------------------------------------------
+# Configuration for "ruff" linter
+# -----------------------------------------------
+
+[tool.ruff]
+line-length = 120
+indent-width = 4
+target-version = "py312"
+exclude = [
+    "src/exobrain/database/migrations/versions",
+]
+
+# -----------------------------------------------
+# Configuration for "ty" type checker
+# -----------------------------------------------
+
+[tool.ty.rules]
+all = "error"
+missing-override-decorator = "ignore"
+
+[tool.ty.src]
+exclude = [
+    "src/exobrain/database/migrations/versions",
+]
+
+[tool.ty.environment]
+python-version = "3.12"

exobrain_database-0.1.0/src/exobrain/database/migrations/README.md

@@ -0,0 +1 @@
+Generic single-database configuration.

exobrain_database-0.1.0/src/exobrain/database/migrations/__init__.py

@@ -0,0 +1,9 @@
+"""Database migration utilities for multi-tenant organization schemas."""
+
+from exobrain.database.migrations.migration_manager import (
+    configure,
+    downgrade,
+    upgrade,
+)
+
+__all__ = ["configure", "upgrade", "downgrade"]

exobrain_database-0.1.0/src/exobrain/database/migrations/alembic.ini

@@ -0,0 +1,104 @@
+# A generic, single database configuration.
+
+[alembic]
+script_location = %(here)s
+version_locations = %(here)s/versions
+file_template = %%(year)d_%%(month).2d_%%(day).2d_%%(hour).2d%%(minute).2d-%%(rev)s_%%(slug)s
+
+timezone = UTC
+
+
+# sys.path path, will be prepended to sys.path if present.
+# defaults to the current working directory.
+prepend_sys_path = .
+
+# timezone to use when rendering the date within the migration file
+# as well as the filename.
+# If specified, requires the python-dateutil library that can be
+# installed by adding `alembic[tz]` to the pip requirements
+# string value is passed to dateutil.tz.gettz()
+# leave blank for localtime
+# timezone =
+
+# max length of characters to apply to the
+# "slug" field
+# truncate_slug_length = 40
+
+# set to 'true' to run the environment during
+# the 'revision' command, regardless of autogenerate
+# revision_environment = false
+
+# set to 'true' to allow .pyc and .pyo files without
+# a source .py file to be detected as revisions in the
+# versions/ directory
+# sourceless = false
+
+# version location specification; This defaults
+# to alembic/versions.  When using multiple version
+# directories, initial revisions must be specified with --version-path.
+# The path separator used here should be the separator specified by "version_path_separator" below.
+
+# version path separator; As mentioned above, this is the character used to split
+# version_locations. The default within new alembic.ini files is "os", which uses os.pathsep.
+# If this key is omitted entirely, it falls back to the legacy behavior of splitting on spaces and/or commas.
+# Valid values for version_path_separator are:
+#
+# version_path_separator = :
+# version_path_separator = ;
+# version_path_separator = space
+version_path_separator = :
+
+# set to 'true' to search source files recursively
+# in each "version_locations" directory
+# new in Alembic version 1.10
+# recursive_version_locations = false
+
+# the output encoding used when revision files
+# are written from script.py.mako
+# output_encoding = utf-8
+
+[post_write_hooks]
+# post_write_hooks defines scripts or Python functions that are run
+# on newly generated revision scripts.  See the documentation for further
+# detail and examples
+
+# format using "black" - use the console_scripts runner, against the "black" entrypoint
+# hooks = black
+# black.type = console_scripts
+# black.entrypoint = black
+# black.options = -l 79 REVISION_SCRIPT_FILENAME
+
+# Logging configuration
+[loggers]
+keys = root,sqlalchemy,alembic
+
+[handlers]
+keys = console
+
+[formatters]
+keys = generic
+
+[logger_root]
+level = WARN
+handlers = console
+qualname =
+
+[logger_sqlalchemy]
+level = WARN
+handlers =
+qualname = sqlalchemy.engine
+
+[logger_alembic]
+level = INFO
+handlers =
+qualname = alembic
+
+[handler_console]
+class = StreamHandler
+args = (sys.stderr,)
+level = NOTSET
+formatter = generic
+
+[formatter_generic]
+format = %(levelname)-5.5s [%(name)s] %(message)s
+datefmt = %H:%M:%S