sqlalchemy-multiple-db 2.1.1__tar.gz → 3.0.0__tar.gz

sqlalchemy_multiple_db-3.0.0/.github/SECURITY.md

@@ -0,0 +1,8 @@
+# Security Policy
+
+## Supported Versions
+
+We will endeavour to support:
+* the most recent minor release with bug fixes
+* the latest minor release from the last major version
+  for 6 months after a new major version is released with critical bug fixes

sqlalchemy_multiple_db-3.0.0/.github/dependabot.yml

@@ -0,0 +1,10 @@
+version: 2
+updates:
+  - package-ecosystem: uv
+    directory: /
+    schedule:
+      interval: monthly
+  - package-ecosystem: github-actions
+    directory: /
+    schedule:
+      interval: monthly

sqlalchemy_multiple_db-3.0.0/.github/workflows/ci.yml

@@ -0,0 +1,36 @@
+name: CI
+
+on:
+  push:
+    branches: [main, master]
+  pull_request:
+    branches: [main, master]
+
+jobs:
+  quality:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.14"
+      - uses: astral-sh/setup-uv@v7
+      - run: uv sync --all-groups --locked
+      - run: uv run ruff format --check src tests
+      - run: uv run ruff check src tests
+      - run: uv run mypy src
+
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.11", "3.12", "3.13", "3.14"]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - uses: astral-sh/setup-uv@v7
+      - run: uv sync --all-groups --locked
+      - run: uv run pytest --cov=sqlalchemy_multiple_db --cov-report=term-missing

sqlalchemy_multiple_db-3.0.0/.github/workflows/publish.yml

@@ -0,0 +1,41 @@
+name: Publish to PyPI
+
+on:
+  push:
+    tags: ["v*"]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.14"
+      - uses: astral-sh/setup-uv@v7
+      - run: uv sync --all-groups --locked
+      - run: uv run ruff format --check src tests
+      - run: uv run ruff check src tests
+      - run: uv run mypy src
+      - run: uv run pytest
+      - run: uv build
+      - run: uv run python -m zipfile -t dist/*.whl
+      - uses: actions/upload-artifact@v4
+        with:
+          name: python-package-distributions
+          path: dist/
+
+  publish-to-pypi:
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/sqlalchemy-multiple-db
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: python-package-distributions
+          path: dist/
+      - uses: pypa/gh-action-pypi-publish@release/v1

sqlalchemy_multiple_db-3.0.0/.gitignore

@@ -0,0 +1,77 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+.idea
+media
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+env/
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+parts/
+sdist/
+var/
+*.egg-info/
+.installed.cfg
+*.egg
+
+configs/local_settings.py
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*,cover
+.hypothesis/
+
+# Translations
+*.pot
+
+# Django stuff:
+*.log
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+#Ipython Notebook
+.ipynb_checkpoints
+venv/*
+env/*
+.venv/
+.env/*
+.uv/
+.mypy_cache/
+.pytest_cache/
+.ruff_cache/
+
+address.txt
+private_keys.txt
+
+# Idea modules
+*.iml

sqlalchemy_multiple_db-3.0.0/CHANGELOG.md

@@ -0,0 +1,112 @@
+
+# Changelog
+
+## 3.0.0 (Unreleased)
+
+### Breaking changes
+
+- Dropped Python 3.7–3.10; supported versions are Python 3.11–3.14.
+- Dropped SQLAlchemy 1.x and require SQLAlchemy 2.x.
+- Replaced `DBConfig`, `DBHelper`, global `db`, `setup`, `session_scope`, `get_status_info`, and `shutdown` with `DatabaseConfig` and explicit `DatabaseManager` lifecycle methods.
+- Removed the implicit default database and `scoped_session` usage.
+- Moved packaging and dependency management to uv, `pyproject.toml`, and `uv.lock`.
+
+## 2.1.0 (2024-10-18)
+
+*  Update pipeline [Pavel Liashkov]
+*  Update version [Pavel Liashkov]
+
+
+## 2.0.0 (2023-08-03)
+
+*  Update sqlalchemy requirement from <1.5,>=1.4 to >=1.4,<2.1 [dependabot[bot]]
+*  Fix pipeline (#27) [Pavel Liashkov]
+*  Update version [Pavel Liashkov]
+
+
+## 1.8.0 (2021-07-26)
+
+*  Relax reqs version [Pavel Liashkov]
+
+
+## 1.7.0 (2021-07-23)
+
+*  Bump sqlalchemy from 1.4.18 to 1.4.19 [dependabot[bot]]
+*  Bump sqlalchemy from 1.4.19 to 1.4.20 [dependabot[bot]]
+*  Bump sqlalchemy from 1.4.20 to 1.4.22 [dependabot[bot]]
+*  Update version.py [Pavel Liashkov]
+
+
+## 1.6.0 (2021-06-18)
+
+*  Bump sqlalchemy from 1.4.17 to 1.4.18 [dependabot[bot]]
+*  Update version.py [Pavel Liashkov]
+
+
+## 1.5.0 (2021-06-04)
+
+*  Bump sqlalchemy from 1.4.15 to 1.4.17 [dependabot[bot]]
+*  Update version.py [Pavel Liashkov]
+
+
+## 1.4.0 (2021-05-18)
+
+*  Bump sqlalchemy from 1.4.13 to 1.4.15 [dependabot[bot]]
+*  Update version.py [Pavel Liashkov]
+
+
+## 1.3.0 (2021-05-05)
+
+*  Bump sqlalchemy from 1.4.8 to 1.4.13 [dependabot[bot]]
+*  Update version.py [Pavel Liashkov]
+
+
+## 1.2.0 (2021-04-16)
+
+*  Bump sqlalchemy from 1.4.5 to 1.4.8 [dependabot[bot]]
+*  Update version.py [Pavel Liashkov]
+
+
+## 1.1.0 (2021-04-05)
+
+*  Bump sqlalchemy from 1.4.0 to 1.4.2 [dependabot[bot]]
+*  Bump sqlalchemy from 1.4.2 to 1.4.5 [dependabot[bot]]
+*  Bump version [Pavel Liashkov]
+
+
+## 1.0.0 (2021-03-17)
+
+*  Add command for checking code [Pavel Liashkov]
+*  Bump sqlalchemy from 1.3.23 to 1.4.0 [dependabot[bot]]
+*  NOTASK: Bump version [Pavel Liashkov]
+*  Bump version [Pavel Liashkov]
+
+
+## 0.1.6 (2021-02-26)
+
+*  Add codecov settings [Pavel Liashkov]
+
+
+## 0.1.5 (2021-02-20)
+
+*  Update Makefile [Pavel Liashkov]
+*  Bump version [Pavel Liashkov]
+
+
+## 0.1.4 (2021-02-08)
+
+*  Update readme [Pavel Liashkov]
+
+
+## 0.1.3 (2021-02-02)
+
+*  Bump sqlalchemy from 1.3.22 to 1.3.23 [dependabot[bot]]
+*  Bump version [Pavel Liashkov]
+
+
+## 0.1.2 (2021-01-23)
+
+*  Fix Readme [Pavel Liashkov]
+*  Bump version [Pavel Liashkov]
+*  Fix package format [Pavel Liashkov]
+

sqlalchemy_multiple_db-3.0.0/Makefile

@@ -0,0 +1,178 @@
+.PHONY: help
+
+#################################################################################
+# GLOBALS                                                                       #
+#################################################################################
+
+PROJECT_DIR := $(shell dirname $(realpath $(lastword $(MAKEFILE_LIST))))
+PROJECT_NAME = sqlalchemy-multiple-db
+
+SRC_PATH = src/sqlalchemy_multiple_db
+LINT_PATHS = src tests
+
+UV ?= uv
+
+#######################
+### System commands
+#######################
+.PHONY: sys/changelog
+## Generating changelog file
+sys/changelog:
+	@echo "Generating CHANGELOG.md..."
+	@echo "" > CHANGELOG.md;
+	@previous_tag=0; \
+	for current_tag in $$(git tag --sort=-creatordate | grep '^v'); do \
+		if [ "$$previous_tag" != 0 ]; then \
+			tag_date=$$(git log -1 --pretty=format:'%ad' --date=short $${previous_tag}); \
+			printf "\n## $${previous_tag} ($${tag_date})\n\n" >> CHANGELOG.md; \
+			git log $${current_tag}...$${previous_tag} --pretty=format:'*  %s [%an]' --reverse | grep -v Merge >> CHANGELOG.md; \
+			printf "\n" >> CHANGELOG.md; \
+		fi; \
+		previous_tag=$${current_tag}; \
+	done
+	@echo "CHANGELOG.md generated successfully."
+
+.PHONY: sys/tag
+## Create and push tag
+sys/tag:
+	@read -p "Enter tag version (e.g., 1.0.0): " TAG; \
+	if [[ $$TAG =~ ^[0-9]+\.[0-9]+\.[0-9]+$$ ]]; then \
+		git tag -a v$$TAG -m v$$TAG; \
+		git push origin v$$TAG; \
+		echo "Tag v$$TAG created and pushed successfully."; \
+	else \
+		echo "Invalid tag format. Please use X.Y.Z (e.g., 1.0.0)"; \
+		exit 1; \
+	fi
+
+
+#################################################################################
+# VIRTUAL ENVIRONMENT                                                           #
+#################################################################################
+
+.PHONY: venv/install/main
+## Install runtime dependencies
+venv/install/main:
+	@echo "Installing runtime dependencies..."
+	$(UV) sync --no-group dev
+	@echo "done"
+	@echo
+
+.PHONY: venv/install/all
+## Install runtime and development dependencies
+venv/install/all:
+	@echo "Installing runtime and development dependencies..."
+	$(UV) sync --all-groups
+	@echo "done"
+	@echo
+
+#################################################################################
+# COMMANDS                                                                      #
+#################################################################################
+
+########################################
+### Code style and static analysis
+########################################
+
+.PHONY: lint/ruff
+## Check formatting and linting with Ruff
+lint/ruff:
+	@echo "Linting with Ruff..."
+	$(UV) run ruff format --check $(LINT_PATHS)
+	$(UV) run ruff check $(LINT_PATHS)
+	@echo "done"
+	@echo
+
+.PHONY: lint/mypy
+## Type-check source with mypy
+lint/mypy:
+	@echo "Type-checking with mypy..."
+	$(UV) run mypy $(SRC_PATH)
+	@echo "done"
+	@echo
+
+.PHONY: lint
+## Run all static checks
+lint: lint/ruff lint/mypy
+
+.PHONY: format
+## Format source code and apply safe lint fixes
+format:
+	@echo "Formatting source code..."
+	$(UV) run ruff format $(LINT_PATHS)
+	$(UV) run ruff check --fix $(LINT_PATHS)
+	@echo "done"
+	@echo
+
+.PHONY: clean
+## Delete generated build artifacts and caches
+clean:
+	@echo "Clearing generated files..."
+	rm -rf .coverage .mypy_cache .pytest_cache .ruff_cache build dist
+	find . -type d -name __pycache__ -prune -exec rm -rf {} +
+	@echo "done"
+	@echo
+
+####################
+### Tests
+####################
+
+.PHONY: test
+## Run tests with coverage
+test:
+	$(UV) run pytest --cov=sqlalchemy_multiple_db --cov-report=term-missing
+
+####################
+### Distribution
+####################
+
+.PHONY: build
+## Build source and wheel distributions
+build:
+	$(UV) build
+
+#################################################################################
+# SELF-DOCUMENTING COMMANDS                                                     #
+#################################################################################
+
+.DEFAULT_GOAL := help
+
+# Inspired by <https://marmelab.com/blog/2016/02/29/auto-documented-makefile.html>
+help:
+	@echo "$$(tput bold)Available rules:$$(tput sgr0)"
+	@echo
+	@sed -n -e "/^## / { \
+		h; \
+		s/.*//; \
+		:doc" \
+		-e "H; \
+		n; \
+		s/^## //; \
+		t doc" \
+		-e "s/:.*//; \
+		G; \
+		s/\\n## /---/; \
+		s/\\n/ /g; \
+		p; \
+	}" ${MAKEFILE_LIST} \
+	| LC_ALL='C' sort --ignore-case \
+	| awk -F '---' \
+		-v ncol=$$(tput cols) \
+		-v indent=19 \
+		-v col_on="$$(tput setaf 6)" \
+		-v col_off="$$(tput sgr0)" \
+	'{ \
+		printf "%s%*s%s ", col_on, -indent, $$1, col_off; \
+		n = split($$2, words, " "); \
+		line_length = ncol - indent; \
+		for (i = 1; i <= n; i++) { \
+			line_length -= length(words[i]) + 1; \
+			if (line_length <= 0) { \
+				line_length = ncol - indent - length(words[i]) - 1; \
+				printf "\n%*s ", -indent, " "; \
+			} \
+			printf "%s ", words[i]; \
+		} \
+		printf "\n"; \
+	}' \
+	| more $(shell test $(shell uname) = Darwin && echo '--no-init --raw-control-chars')

sqlalchemy_multiple_db-3.0.0/PKG-INFO

@@ -0,0 +1,123 @@
+Metadata-Version: 2.4
+Name: sqlalchemy-multiple-db
+Version: 3.0.0
+Summary: Explicit SQLAlchemy session management for multiple named databases
+Project-URL: Changelog, https://github.com/bigbag/sqlalchemy-multiple-db/blob/main/CHANGELOG.md
+Project-URL: Homepage, https://github.com/bigbag/sqlalchemy-multiple-db
+Project-URL: Issues, https://github.com/bigbag/sqlalchemy-multiple-db/issues
+Author-email: Pavel Liashkov <pavel.liashkov@protonmail.com>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: database,multi-database,session,sqlalchemy
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Database
+Classifier: Topic :: Software Development :: Libraries
+Requires-Python: >=3.11
+Requires-Dist: sqlalchemy>=2.0.51
+Description-Content-Type: text/markdown
+
+# sqlalchemy-multiple-db
+
+Explicit, typed SQLAlchemy 2.x session management for multiple named databases.
+
+## Requirements
+
+- Python 3.11, 3.12, 3.13, or 3.14
+- SQLAlchemy 2.x (installed automatically)
+
+## Installation
+
+```bash
+uv add sqlalchemy-multiple-db
+# or
+uv pip install sqlalchemy-multiple-db
+```
+
+## Quick start
+
+```python
+from sqlalchemy import text
+from sqlalchemy_multiple_db import DatabaseConfig, DatabaseManager
+
+configs = {
+    "primary": DatabaseConfig(url="sqlite:///primary.db"),
+    "analytics": DatabaseConfig(url="sqlite:///analytics.db"),
+}
+
+with DatabaseManager(configs) as databases:
+    with databases.session("primary") as session:
+        session.execute(text("CREATE TABLE IF NOT EXISTS events (id INTEGER PRIMARY KEY)"))
+        session.execute(text("INSERT INTO events DEFAULT VALUES"))
+
+    with databases.session("analytics") as session:
+        session.execute(text("SELECT 1"))
+
+    assert databases.healthcheck() == {"primary": True, "analytics": True}
+```
+
+Each `session(name)` call creates a new SQLAlchemy `Session`. A normal block commits; an exception
+rolls back and is re-raised; the session always closes. Call `close()` when not using the manager as a
+context manager. `close()` is idempotent, but the manager cannot be used afterward.
+
+## Configuration
+
+`DatabaseConfig(url, engine_options={}, session_options={})` forwards option mappings to SQLAlchemy's
+`create_engine` and `sessionmaker`. Options are copied at construction. The library deliberately does
+not choose pool sizes or deprecated autocommit behavior; configure dialect-specific options explicitly
+when needed.
+
+`healthcheck()` runs `SELECT 1` for every configured engine and returns a `{name: bool}` mapping.
+SQLAlchemy connection failures are logged and reported as `False` without stopping checks for other
+databases.
+
+## Migrating from 2.x
+
+| 2.x | 3.0 |
+| --- | --- |
+| `DBConfig(dsn="...")` | `DatabaseConfig(url="...")` |
+| `DBHelper` or global `db` | `DatabaseManager(configurations)` |
+| `setup()` | construct the manager |
+| `session_scope()` | `session(name)` |
+| `get_status_info()` | `healthcheck()` |
+| `shutdown()` | `close()` or `with DatabaseManager(...)` |
+
+There is no global manager or implicit `default` database in 3.0. Name every database explicitly.
+
+## Examples
+
+Each example uses temporary SQLite files and needs no external database server:
+
+- [basic_usage.py](examples/basic_usage.py) — create, write to, and query isolated primary and analytics databases.
+- [transaction_rollback.py](examples/transaction_rollback.py) — verify that an exception rolls back a transaction.
+- [healthcheck_and_options.py](examples/healthcheck_and_options.py) — configure engine/session options and inspect database health.
+
+Run an example from a synced checkout:
+
+```bash
+uv run python examples/basic_usage.py
+```
+
+## Development
+
+```bash
+uv sync --all-groups
+uv run pytest
+uv run ruff format --check src tests
+uv run ruff check src tests
+uv run mypy src
+uv build
+```
+
+Use `uv add <package>` to add a dependency and `uv lock --upgrade` to refresh all locked dependency
+versions. Commit every `pyproject.toml` and `uv.lock` change together.
+
+## License
+
+Apache-2.0. See [LICENSE](LICENSE).

sqlalchemy_multiple_db-3.0.0/README.md

@@ -0,0 +1,98 @@
+# sqlalchemy-multiple-db
+
+Explicit, typed SQLAlchemy 2.x session management for multiple named databases.
+
+## Requirements
+
+- Python 3.11, 3.12, 3.13, or 3.14
+- SQLAlchemy 2.x (installed automatically)
+
+## Installation
+
+```bash
+uv add sqlalchemy-multiple-db
+# or
+uv pip install sqlalchemy-multiple-db
+```
+
+## Quick start
+
+```python
+from sqlalchemy import text
+from sqlalchemy_multiple_db import DatabaseConfig, DatabaseManager
+
+configs = {
+    "primary": DatabaseConfig(url="sqlite:///primary.db"),
+    "analytics": DatabaseConfig(url="sqlite:///analytics.db"),
+}
+
+with DatabaseManager(configs) as databases:
+    with databases.session("primary") as session:
+        session.execute(text("CREATE TABLE IF NOT EXISTS events (id INTEGER PRIMARY KEY)"))
+        session.execute(text("INSERT INTO events DEFAULT VALUES"))
+
+    with databases.session("analytics") as session:
+        session.execute(text("SELECT 1"))
+
+    assert databases.healthcheck() == {"primary": True, "analytics": True}
+```
+
+Each `session(name)` call creates a new SQLAlchemy `Session`. A normal block commits; an exception
+rolls back and is re-raised; the session always closes. Call `close()` when not using the manager as a
+context manager. `close()` is idempotent, but the manager cannot be used afterward.
+
+## Configuration
+
+`DatabaseConfig(url, engine_options={}, session_options={})` forwards option mappings to SQLAlchemy's
+`create_engine` and `sessionmaker`. Options are copied at construction. The library deliberately does
+not choose pool sizes or deprecated autocommit behavior; configure dialect-specific options explicitly
+when needed.
+
+`healthcheck()` runs `SELECT 1` for every configured engine and returns a `{name: bool}` mapping.
+SQLAlchemy connection failures are logged and reported as `False` without stopping checks for other
+databases.
+
+## Migrating from 2.x
+
+| 2.x | 3.0 |
+| --- | --- |
+| `DBConfig(dsn="...")` | `DatabaseConfig(url="...")` |
+| `DBHelper` or global `db` | `DatabaseManager(configurations)` |
+| `setup()` | construct the manager |
+| `session_scope()` | `session(name)` |
+| `get_status_info()` | `healthcheck()` |
+| `shutdown()` | `close()` or `with DatabaseManager(...)` |
+
+There is no global manager or implicit `default` database in 3.0. Name every database explicitly.
+
+## Examples
+
+Each example uses temporary SQLite files and needs no external database server:
+
+- [basic_usage.py](examples/basic_usage.py) — create, write to, and query isolated primary and analytics databases.
+- [transaction_rollback.py](examples/transaction_rollback.py) — verify that an exception rolls back a transaction.
+- [healthcheck_and_options.py](examples/healthcheck_and_options.py) — configure engine/session options and inspect database health.
+
+Run an example from a synced checkout:
+
+```bash
+uv run python examples/basic_usage.py
+```
+
+## Development
+
+```bash
+uv sync --all-groups
+uv run pytest
+uv run ruff format --check src tests
+uv run ruff check src tests
+uv run mypy src
+uv build
+```
+
+Use `uv add <package>` to add a dependency and `uv lock --upgrade` to refresh all locked dependency
+versions. Commit every `pyproject.toml` and `uv.lock` change together.
+
+## License
+
+Apache-2.0. See [LICENSE](LICENSE).