postgresledger 0.0.1__tar.gz → 0.0.2__tar.gz

{postgresledger-0.0.1 → postgresledger-0.0.2}/PKG-INFO

@@ -1,14 +1,27 @@
 Metadata-Version: 2.4
 Name: postgresledger
-Version: 0.0.1
+Version: 0.0.2
 Summary: Versioned PostgreSQL migrations from plain SQL, without an ORM: generated from schema.sql, tracked per database, with drift detection
+Keywords: postgresql,postgres,migrations,database-migrations,schema,sql,drift,pgschema
 Author: Nebojša Mrkić
 Author-email: Nebojša Mrkić <mrkic.nebojsa@gmail.com>
 License-Expression: MIT
 License-File: LICENSE
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: System Administrators
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Operating System :: MacOS
 Classifier: Programming Language :: Python :: 3
+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: Programming Language :: SQL
 Classifier: Topic :: Database
-Classifier: Environment :: Console
+Classifier: Topic :: Software Development :: Version Control
 Requires-Dist: python-dotenv>=1.2.4
 Requires-Python: >=3.11
 Project-URL: Homepage, https://github.com/nmrkic/postgresledger
@@ -19,6 +32,11 @@ Description-Content-Type: text/markdown
 
 # postgresledger
 
+[![PyPI](https://img.shields.io/pypi/v/postgresledger)](https://pypi.org/project/postgresledger/)
+[![Python](https://img.shields.io/pypi/pyversions/postgresledger)](https://pypi.org/project/postgresledger/)
+[![Tests](https://github.com/nmrkic/postgresledger/actions/workflows/tests.yml/badge.svg)](https://github.com/nmrkic/postgresledger/actions/workflows/tests.yml)
+[![License: MIT](https://img.shields.io/pypi/l/postgresledger)](https://github.com/nmrkic/postgresledger/blob/main/LICENSE)
+
 Versioned migrations for PostgreSQL from plain SQL, without an ORM (tables,
 views, materialized views, functions, triggers), built on
 [pgschema](https://www.pgschema.com). The command is `pgl`.
@@ -264,6 +282,8 @@ environment; a variable set there wins over `.env`. `pgl --env-file .env.uat …
 (or `PGL_ENV_FILE=.env.uat`) picks another file for one run.
 Run `pgl` in the folder with `postgresledger.toml`, or point to it with
 `--config PATH`. `pgl <command> -h` describes each command.
+`baseline`, `new`, `capture` and `drift` print only what changed;
+`--verbose` (`-v`) prints pgschema's whole plan, SQL included.
 
 ## Developing postgresledger
 

{postgresledger-0.0.1 → postgresledger-0.0.2}/README.md

@@ -1,5 +1,10 @@
 # postgresledger
 
+[![PyPI](https://img.shields.io/pypi/v/postgresledger)](https://pypi.org/project/postgresledger/)
+[![Python](https://img.shields.io/pypi/pyversions/postgresledger)](https://pypi.org/project/postgresledger/)
+[![Tests](https://github.com/nmrkic/postgresledger/actions/workflows/tests.yml/badge.svg)](https://github.com/nmrkic/postgresledger/actions/workflows/tests.yml)
+[![License: MIT](https://img.shields.io/pypi/l/postgresledger)](https://github.com/nmrkic/postgresledger/blob/main/LICENSE)
+
 Versioned migrations for PostgreSQL from plain SQL, without an ORM (tables,
 views, materialized views, functions, triggers), built on
 [pgschema](https://www.pgschema.com). The command is `pgl`.
@@ -245,6 +250,8 @@ environment; a variable set there wins over `.env`. `pgl --env-file .env.uat …
 (or `PGL_ENV_FILE=.env.uat`) picks another file for one run.
 Run `pgl` in the folder with `postgresledger.toml`, or point to it with
 `--config PATH`. `pgl <command> -h` describes each command.
+`baseline`, `new`, `capture` and `drift` print only what changed;
+`--verbose` (`-v`) prints pgschema's whole plan, SQL included.
 
 ## Developing postgresledger
 

{postgresledger-0.0.1 → postgresledger-0.0.2}/pyproject.toml

@@ -1,16 +1,38 @@
 [project]
 name = "postgresledger"
-version = "0.0.1"
+version = "0.0.2"
 description = "Versioned PostgreSQL migrations from plain SQL, without an ORM: generated from schema.sql, tracked per database, with drift detection"
 readme = "README.md"
 license = "MIT"
 license-files = ["LICENSE"]
 requires-python = ">=3.11"
 dependencies = ["python-dotenv>=1.2.4"]
+keywords = [
+    "postgresql",
+    "postgres",
+    "migrations",
+    "database-migrations",
+    "schema",
+    "sql",
+    "drift",
+    "pgschema",
+]
 classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Environment :: Console",
+    "Intended Audience :: Developers",
+    "Intended Audience :: System Administrators",
+    "Operating System :: POSIX :: Linux",
+    "Operating System :: MacOS",
     "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Programming Language :: SQL",
     "Topic :: Database",
-    "Environment :: Console",
+    "Topic :: Software Development :: Version Control",
 ]
 
 [[project.authors]]

{postgresledger-0.0.1 → postgresledger-0.0.2}/pyproject.toml.orig

@@ -1,6 +1,6 @@
 [project]
 name = "postgresledger"
-version = "0.0.1"  # set from the release tag by .github/workflows/publish.yml, not here
+version = "0.0.2"  # set from the release tag by .github/workflows/publish.yml, not here
 description = "Versioned PostgreSQL migrations from plain SQL, without an ORM: generated from schema.sql, tracked per database, with drift detection"
 readme = "README.md"
 license = "MIT"
@@ -10,10 +10,23 @@ authors = [{ name = "Nebojša Mrkić", email = "mrkic.nebojsa@gmail.com" }]
 dependencies = [
     "python-dotenv>=1.2.4",
 ]
+keywords = ["postgresql", "postgres", "migrations", "database-migrations", "schema", "sql", "drift", "pgschema"]
 classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Environment :: Console",
+    "Intended Audience :: Developers",
+    "Intended Audience :: System Administrators",
+    "Operating System :: POSIX :: Linux",
+    "Operating System :: MacOS",
     "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Programming Language :: SQL",
     "Topic :: Database",
-    "Environment :: Console",
+    "Topic :: Software Development :: Version Control",
 ]
 
 [project.urls]

{postgresledger-0.0.1 → postgresledger-0.0.2}/src/postgresledger/cli.py

@@ -17,6 +17,8 @@ NO_CONFIG = {"init", "setup"}
 # commands that read the project but never touch a database
 # (compare with two snapshots; compare with one checks DATABASE_NAME itself)
 NO_DATABASE = {"new", "compare"}
+# commands that make a pgschema plan; --verbose prints all of it, SQL included
+VERBOSE = {"baseline", "new", "drift", "capture"}
 
 INTRO = """\
 Versioned PostgreSQL migrations from plain SQL, without an ORM.
@@ -60,6 +62,11 @@ def add_apply_arguments(command_parser: argparse.ArgumentParser) -> None:
     command_parser.add_argument("--dry-run", action="store_true", help="only list what would be applied")
 
 
+def add_verbose_argument(command_parser: argparse.ArgumentParser) -> None:
+    command_parser.add_argument("-v", "--verbose", action="store_true",
+                                help="print pgschema's whole plan, including the SQL")
+
+
 def add_snapshot_arguments(command_parser: argparse.ArgumentParser) -> None:
     command_parser.add_argument("name", help="label for the database, e.g. prod")
 
@@ -180,6 +187,8 @@ def parser() -> argparse.ArgumentParser:
         command_parser.set_defaults(fn=command_function)
         if command.add_arguments is not None:
             command.add_arguments(command_parser)
+        if command.name in VERBOSE:
+            add_verbose_argument(command_parser)
     return main_parser
 
 

{postgresledger-0.0.1 → postgresledger-0.0.2}/src/postgresledger/commands.py

@@ -19,6 +19,7 @@ from .core import (
     list_migrations,
     pgschema_dump,
     pgschema_plan,
+    print_plan,
     psql,
     record_migration_sql,
     require_up_to_date,
@@ -112,7 +113,8 @@ def cmd_baseline(cfg: Config, connection: Connection, args) -> int:
             cfg.schema_file.parent.mkdir(parents=True, exist_ok=True)
             print(f"- dump {connection.label} -> {relative(cfg.schema_file)}")
             pgschema_dump(cfg, connection, cfg.schema_file)
-            baseline = generate_migration(cfg, scratch_server, "baseline", f"baseline taken from {connection.database}")
+            baseline = generate_migration(cfg, scratch_server, "baseline", f"baseline taken from {connection.database}",
+                                          args.verbose)
             if baseline is None:
                 sys.exit("the database is empty, nothing to snapshot")
             ensure_meta(cfg, connection)
@@ -130,7 +132,7 @@ def cmd_baseline(cfg: Config, connection: Connection, args) -> int:
             plan = pgschema_plan(cfg, shadow, actual, scratch_server)
     if plan.sql:
         print(f"✘ {connection.label} does not match the migrations, so they cannot be recorded as already there:\n")
-        print(plan.human)
+        print_plan(plan, args.verbose)
         print("\nempty database: `pgl apply` instead; otherwise align it first (see `pgl compare`)")
         return 1
     # every record in one transaction: all of them or none
@@ -142,7 +144,7 @@ def cmd_baseline(cfg: Config, connection: Connection, args) -> int:
 
 def cmd_new(cfg: Config, args) -> None:
     with scratch.server() as scratch_server:
-        generate_migration(cfg, scratch_server, args.name, args.note or "change in schema.sql")
+        generate_migration(cfg, scratch_server, args.name, args.note or "change in schema.sql", args.verbose)
 
 
 def cmd_apply(cfg: Config, connection: Connection, args) -> None:
@@ -217,7 +219,7 @@ def cmd_drift(cfg: Config, connection: Connection, args) -> int:
         print(f"✔ {connection.label}: no drift, the database matches its migrations")
         return 0
     print(f"✘ {connection.label}: DRIFT - the database was changed outside of migrations:\n")
-    print(plan.human)
+    print_plan(plan, args.verbose)
     if pending:
         print("\nrun `pgl apply` first, then keep or drop the changes:")
     print("\nkeep the changes:   pgl capture <name>")
@@ -233,7 +235,7 @@ def cmd_capture(cfg: Config, connection: Connection, args) -> None:
     pgschema_dump(cfg, connection, cfg.schema_file)
     note = f"manual changes captured from {connection.database} (recorded as captured there)"
     with scratch.server() as scratch_server:
-        migration = generate_migration(cfg, scratch_server, args.name, note)
+        migration = generate_migration(cfg, scratch_server, args.name, note, args.verbose)
     if migration is None:
         cfg.schema_file.write_text(schema_before)
         print(f"{connection.label}: no drift, nothing captured")

{postgresledger-0.0.1 → postgresledger-0.0.2}/src/postgresledger/core.py

@@ -212,12 +212,32 @@ def pgschema_dump(cfg: Config, connection: Connection, output_file: Path) -> Non
     output_file.write_text(dump)
 
 
+# where pgschema's readable plan starts repeating the whole SQL
+DDL_HEADER = "DDL to be executed:"
+
+
 @dataclass(frozen=True)
 class Plan:
     """What pgschema would change, in two forms. Both are empty when there is nothing to change."""
 
     sql: str  # the statements, e.g. for a migration file
-    human: str  # the same changes as a readable list for the terminal
+    human: str  # the same changes as a readable list for the terminal, followed by the SQL
+
+    @property
+    def changes(self) -> str:
+        """`human` without the SQL: the summary and the list of changed objects."""
+        return self.human.split(DDL_HEADER)[0].strip()
+
+    @property
+    def headline(self) -> str:
+        """The size of the plan, e.g. "52 to add" from pgschema's first line "Plan: 52 to add."."""
+        first_line = self.human.splitlines()[0] if self.human else ""
+        return first_line.removeprefix("Plan:").strip().removesuffix(".")
+
+
+def print_plan(plan: Plan, verbose: bool) -> None:
+    """The changed objects, and with --verbose also the SQL."""
+    print(plan.human if verbose else plan.changes)
 
 
 def pgschema_plan(cfg: Config, connection: Connection, desired: Path, scratch: Connection) -> Plan:
@@ -265,8 +285,12 @@ def write_migration(cfg: Config, name: str, sql: str, note: str) -> Migration:
     return Migration(version, name, path)
 
 
-def generate_migration(cfg: Config, scratch: Connection, name: str, note: str) -> Migration | None:
-    """schema.sql vs (every migration applied) -> new migration, then check that it reproduces schema.sql."""
+def generate_migration(cfg: Config, scratch: Connection, name: str, note: str,
+                       verbose: bool = False) -> Migration | None:
+    """schema.sql vs (every migration applied) -> new migration, then check that it reproduces schema.sql.
+
+    The plan is only printed with `verbose`: it is the content of the new file anyway.
+    """
     existing = list_migrations(cfg)
     print(f"- building the state of {len(existing)} existing migrations (scratch Postgres)")
     shadow = build_shadow(cfg, scratch, existing)
@@ -275,14 +299,16 @@ def generate_migration(cfg: Config, scratch: Connection, name: str, note: str) -
         print("no changes compared to the existing migrations")
         return None
     migration = write_migration(cfg, name, plan.sql, note)
-    print(plan.human)
+    if verbose:
+        print(plan.human)
     print(f"- verifying {migration.path.name}")
     apply_file(cfg, shadow, migration)
     # with the new migration applied, nothing should be left to change
     leftover = pgschema_plan(cfg, shadow, cfg.schema_file, scratch)
     if leftover.sql:
+        # always in full: this is the case to debug
         print(leftover.human)
         migration.path.unlink()
         sys.exit("after applying the migration the result still differs from schema.sql - migration deleted")
-    print(f"✔ created {relative(migration.path)}")
+    print(f"✔ created {relative(migration.path)} ({plan.headline})")
     return migration