live-alembic 0.3.3__tar.gz

live_alembic-0.3.3/LICENSE

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

live_alembic-0.3.3/PKG-INFO

@@ -0,0 +1,219 @@
+Metadata-Version: 2.4
+Name: live-alembic
+Version: 0.3.3
+Summary: A live migration system for Alembic.
+Author-email: Olof Tjerngren <olof@tjerngren.net>
+License-Expression: LGPL-3.0-or-later
+Project-URL: Repository, https://gitlab.com/Resample2545/live-alembic
+Project-URL: Issues, https://gitlab.com/Resample2545/live-alembic/-/issues
+Keywords: alembic,sqlalchemy,migrations,database,schema,ddl
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+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 :: Python Modules
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: alembic>=1.7.7
+Requires-Dist: sqlalchemy>=2.0.31
+Requires-Dist: click>=8.0.3
+Requires-Dist: jinja2>=3.1.6
+Provides-Extra: postgresql
+Requires-Dist: psycopg2-binary>=2.9; extra == "postgresql"
+Provides-Extra: mysql
+Requires-Dist: PyMySQL>=1.1; extra == "mysql"
+Provides-Extra: mariadb
+Requires-Dist: PyMySQL>=1.1; extra == "mariadb"
+Provides-Extra: cockroachdb
+Requires-Dist: sqlalchemy-cockroachdb; extra == "cockroachdb"
+Requires-Dist: psycopg2-binary>=2.9; extra == "cockroachdb"
+Provides-Extra: mssql
+Requires-Dist: pymssql; extra == "mssql"
+Dynamic: license-file
+
+# Live Alembic
+
+Apply database migrations without migration files. Live Alembic uses Alembic's
+autogeneration to diff your SQLAlchemy models against the live database and
+applies DDL directly — no `versions/` directory, no commit-to-run cycle.
+
+## Install
+
+```bash
+pip install live-alembic
+```
+
+## Quickstart
+
+**1. Create `migrate_env.py`** in your project root:
+
+```python
+from sqlalchemy import Column, Integer, String
+from sqlalchemy.orm import declarative_base
+
+# SQLite
+db_url = "sqlite:///myapp.db"
+
+# PostgreSQL
+# db_url = "postgresql+psycopg2://user:password@localhost/mydb"
+
+# MySQL / MariaDB
+# db_url = "mysql+pymysql://user:password@localhost/mydb"
+
+Base = declarative_base()
+
+class User(Base):
+    __tablename__ = "users"
+    id    = Column(Integer, primary_key=True)
+    name  = Column(String(100))
+    email = Column(String(255))
+
+target_metadata = Base.metadata
+
+# Optional: List of tables to ignore (e.g. tables managed by other applications)
+# ignore_tables = ["some_external_table"]
+```
+
+**2. Check for pending changes:**
+
+```bash
+livealembic check
+```
+
+Exits `0` if the schema is in sync, `1` if changes are pending.
+
+**3. Apply changes:**
+
+```bash
+livealembic migrate
+```
+
+## CLI Reference
+
+```
+livealembic check   [--file PATH] [--format text|json] [--verbose]
+livealembic migrate [--file PATH] [--format text|json] [--verbose]
+livealembic --version
+```
+
+| Command   | Description                        | Exit code          |
+|-----------|------------------------------------|--------------------|
+| `check`   | Show pending changes, do not apply | 1 if changes exist |
+| `migrate` | Apply pending changes              | 1 on error         |
+
+| Option          | Default          | Description                             |
+|-----------------|------------------|-----------------------------------------|
+| `--file PATH`   | `migrate_env.py` | Path to your configuration module       |
+| `--format json` | `text`           | Machine-readable JSON output            |
+| `--verbose`     | off              | Include raw operation details in output |
+
+### Example output
+
+```
+  Create table "orders"
+  Add column 'phone' (VARCHAR(20)) to table 'users'
+  Drop column 'legacy_id' from table 'users'
+  Alter column 'status' on 'orders' to type INTEGER
+```
+
+### CI / CD usage
+
+```bash
+# Fail the pipeline if the schema has drifted
+livealembic check --file config/migrate_env.py
+
+# Apply during deployment
+livealembic migrate --file config/migrate_env.py
+```
+
+## Package Entry Points
+
+Other libraries can automatically include SQLAlchemy models into the application's migration metadata by registering an entry point under the `live_alembic.models` group. Live Alembic dynamically loads all registered entry points under this group and merges their tables into the application's `target_metadata`.
+
+The entry point can point to:
+* A SQLAlchemy `MetaData` instance.
+* A SQLAlchemy Declarative Base (or registry) subclass with a `metadata` attribute.
+* A SQLAlchemy `Table` object.
+* A module—in which case Live Alembic will inspect its attributes to discover any `MetaData`, Declarative Base, or `Table` instances.
+
+Example registration in a library's `pyproject.toml`:
+
+```toml
+[project.entry-points."live_alembic.models"]
+my_library_models = "my_library.models:metadata"
+```
+
+## Hooks
+
+Define `before_migrate` and/or `after_migrate` in `migrate_env.py` to run data
+migrations in the same transaction as the schema change:
+
+```python
+from live_alembic import Changes
+from sqlalchemy import text
+
+def before_migrate(changes: Changes, connection):
+    if changes.added_column("users", "full_name"):
+        connection.execute(
+            text("UPDATE users SET full_name = first_name || ' ' || last_name")
+        )
+
+def after_migrate(changes: Changes, connection):
+    if changes.dropped_column("users", "legacy_token"):
+        connection.execute(text("DELETE FROM audit_log WHERE action = 'token_refresh'"))
+```
+
+Both hooks receive a `Changes` helper and the active connection.  If a hook
+raises, the transaction is rolled back (schema + data).
+
+See [documentation/usage/usage.org](documentation/usage/usage.org) for the full
+hooks API, database-specific notes, and programmatic API docs.
+
+## Testing
+
+Complete development tests require `docker compose` for database integration.
+
+### Local Tests
+
+Run the standard test suite against SQLite (no Docker required):
+
+```bash
+make test
+```
+
+### Database Integration Tests
+
+Start database services and run tests against a specific backend:
+
+```bash
+make test-postgresql
+make test-mysql
+```
+
+Or run against all supported databases sequentially:
+
+```bash
+make test-all
+```
+
+### Test Matrix (Tox)
+
+Run the full matrix of supported Python versions and databases:
+
+```bash
+make tox
+```
+
+### Coverage
+
+Generate a coverage report for the SQLite tests:
+
+```bash
+make coverage
+```

live_alembic-0.3.3/pyproject.toml

@@ -0,0 +1,80 @@
+[project]
+name = "live-alembic"
+version = "0.3.3"
+description = "A live migration system for Alembic."
+readme = "readme.md"
+authors = [
+    {name = "Olof Tjerngren", email = "olof@tjerngren.net"},
+]
+license = "LGPL-3.0-or-later"
+license-files = ["LICENSE"]
+keywords = ["alembic", "sqlalchemy", "migrations", "database", "schema", "ddl"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Environment :: Console",
+    "Intended Audience :: Developers",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Topic :: Database",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+]
+dependencies = [
+    "alembic>=1.7.7",
+    "sqlalchemy>=2.0.31",
+    "click>=8.0.3",
+    "jinja2>=3.1.6",
+]
+requires-python = ">=3.12"
+
+[project.urls]
+Repository = "https://gitlab.com/Resample2545/live-alembic"
+Issues = "https://gitlab.com/Resample2545/live-alembic/-/issues"
+
+[project.scripts]
+livealembic = "live_alembic.cli:main"
+
+[project.optional-dependencies]
+postgresql = ["psycopg2-binary>=2.9"]
+mysql      = ["PyMySQL>=1.1"]
+mariadb    = ["PyMySQL>=1.1"]
+cockroachdb = ["sqlalchemy-cockroachdb", "psycopg2-binary>=2.9"]
+mssql      = ["pymssql"]
+
+[dependency-groups]
+dev = [
+    "behave",
+    "coverage",
+    "psycopg2-binary>=2.9",
+    "PyMySQL>=1.1",
+    "sqlalchemy-cockroachdb",
+    "pymssql",
+]
+
+[build-system]
+requires = ["setuptools>=77.0"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools]
+packages = ["live_alembic"]
+package-dir = {"" = "src"}
+
+[tool.coverage.run]
+source = ["src/live_alembic"]
+branch = true
+
+[tool.coverage.report]
+show_missing = true
+fail_under = 80
+exclude_lines = [
+    "pragma: no cover",
+    "def __repr__",
+    "if __name__ == .__main__.:",
+    "raise NotImplementedError",
+    "if TYPE_CHECKING:",
+]
+
+[tool.uv]
+exclude-newer = "7 days"

live_alembic-0.3.3/readme.md

@@ -0,0 +1,180 @@
+# Live Alembic
+
+Apply database migrations without migration files. Live Alembic uses Alembic's
+autogeneration to diff your SQLAlchemy models against the live database and
+applies DDL directly — no `versions/` directory, no commit-to-run cycle.
+
+## Install
+
+```bash
+pip install live-alembic
+```
+
+## Quickstart
+
+**1. Create `migrate_env.py`** in your project root:
+
+```python
+from sqlalchemy import Column, Integer, String
+from sqlalchemy.orm import declarative_base
+
+# SQLite
+db_url = "sqlite:///myapp.db"
+
+# PostgreSQL
+# db_url = "postgresql+psycopg2://user:password@localhost/mydb"
+
+# MySQL / MariaDB
+# db_url = "mysql+pymysql://user:password@localhost/mydb"
+
+Base = declarative_base()
+
+class User(Base):
+    __tablename__ = "users"
+    id    = Column(Integer, primary_key=True)
+    name  = Column(String(100))
+    email = Column(String(255))
+
+target_metadata = Base.metadata
+
+# Optional: List of tables to ignore (e.g. tables managed by other applications)
+# ignore_tables = ["some_external_table"]
+```
+
+**2. Check for pending changes:**
+
+```bash
+livealembic check
+```
+
+Exits `0` if the schema is in sync, `1` if changes are pending.
+
+**3. Apply changes:**
+
+```bash
+livealembic migrate
+```
+
+## CLI Reference
+
+```
+livealembic check   [--file PATH] [--format text|json] [--verbose]
+livealembic migrate [--file PATH] [--format text|json] [--verbose]
+livealembic --version
+```
+
+| Command   | Description                        | Exit code          |
+|-----------|------------------------------------|--------------------|
+| `check`   | Show pending changes, do not apply | 1 if changes exist |
+| `migrate` | Apply pending changes              | 1 on error         |
+
+| Option          | Default          | Description                             |
+|-----------------|------------------|-----------------------------------------|
+| `--file PATH`   | `migrate_env.py` | Path to your configuration module       |
+| `--format json` | `text`           | Machine-readable JSON output            |
+| `--verbose`     | off              | Include raw operation details in output |
+
+### Example output
+
+```
+  Create table "orders"
+  Add column 'phone' (VARCHAR(20)) to table 'users'
+  Drop column 'legacy_id' from table 'users'
+  Alter column 'status' on 'orders' to type INTEGER
+```
+
+### CI / CD usage
+
+```bash
+# Fail the pipeline if the schema has drifted
+livealembic check --file config/migrate_env.py
+
+# Apply during deployment
+livealembic migrate --file config/migrate_env.py
+```
+
+## Package Entry Points
+
+Other libraries can automatically include SQLAlchemy models into the application's migration metadata by registering an entry point under the `live_alembic.models` group. Live Alembic dynamically loads all registered entry points under this group and merges their tables into the application's `target_metadata`.
+
+The entry point can point to:
+* A SQLAlchemy `MetaData` instance.
+* A SQLAlchemy Declarative Base (or registry) subclass with a `metadata` attribute.
+* A SQLAlchemy `Table` object.
+* A module—in which case Live Alembic will inspect its attributes to discover any `MetaData`, Declarative Base, or `Table` instances.
+
+Example registration in a library's `pyproject.toml`:
+
+```toml
+[project.entry-points."live_alembic.models"]
+my_library_models = "my_library.models:metadata"
+```
+
+## Hooks
+
+Define `before_migrate` and/or `after_migrate` in `migrate_env.py` to run data
+migrations in the same transaction as the schema change:
+
+```python
+from live_alembic import Changes
+from sqlalchemy import text
+
+def before_migrate(changes: Changes, connection):
+    if changes.added_column("users", "full_name"):
+        connection.execute(
+            text("UPDATE users SET full_name = first_name || ' ' || last_name")
+        )
+
+def after_migrate(changes: Changes, connection):
+    if changes.dropped_column("users", "legacy_token"):
+        connection.execute(text("DELETE FROM audit_log WHERE action = 'token_refresh'"))
+```
+
+Both hooks receive a `Changes` helper and the active connection.  If a hook
+raises, the transaction is rolled back (schema + data).
+
+See [documentation/usage/usage.org](documentation/usage/usage.org) for the full
+hooks API, database-specific notes, and programmatic API docs.
+
+## Testing
+
+Complete development tests require `docker compose` for database integration.
+
+### Local Tests
+
+Run the standard test suite against SQLite (no Docker required):
+
+```bash
+make test
+```
+
+### Database Integration Tests
+
+Start database services and run tests against a specific backend:
+
+```bash
+make test-postgresql
+make test-mysql
+```
+
+Or run against all supported databases sequentially:
+
+```bash
+make test-all
+```
+
+### Test Matrix (Tox)
+
+Run the full matrix of supported Python versions and databases:
+
+```bash
+make tox
+```
+
+### Coverage
+
+Generate a coverage report for the SQLite tests:
+
+```bash
+make coverage
+```

live_alembic-0.3.3/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

live_alembic-0.3.3/src/live_alembic/__init__.py

@@ -0,0 +1,3 @@
+from .live_alembic import LiveAlembic, Changes, UnsupportedFeatureError
+
+__all__ = ["LiveAlembic", "Changes", "UnsupportedFeatureError"]