mongomig 0.1.0.dev0__tar.gz

mongomig-0.1.0.dev0/.github/workflows/ci.yml

@@ -0,0 +1,57 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v6
+        with:
+          python-version: "3.12"
+      - run: uv venv && uv pip install -e ".[dev]"
+      - run: .venv/bin/ruff check src tests
+      - run: .venv/bin/ruff format --check src tests
+      - run: .venv/bin/mypy
+
+  unit:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python: ["3.11", "3.12", "3.13"]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v6
+        with:
+          python-version: ${{ matrix.python }}
+      - run: uv venv && uv pip install -e ".[dev]"
+      - run: .venv/bin/pytest tests/unit --cov=mongomig --cov-report=term-missing
+
+  integration:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        mongo: ["6.0", "7.0", "8.0"]
+    env:
+      MONGO_VERSION: ${{ matrix.mongo }}
+      MONGOMIG_REQUIRE_MONGO: "1"
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v6
+        with:
+          python-version: "3.12"
+      - run: docker compose up -d --wait
+      - run: uv venv && uv pip install -e ".[dev]"
+      - run: .venv/bin/pytest tests/integration -m integration
+      - if: failure()
+        run: docker compose logs mongo

mongomig-0.1.0.dev0/.github/workflows/release.yml

@@ -0,0 +1,58 @@
+name: Release
+
+# Publishes to PyPI when a GitHub Release is published.
+# Uses PyPI Trusted Publishing (OIDC): no API tokens are stored in the repo.
+# One-time setup: add a "pending publisher" on pypi.org for this repo,
+# workflow `release.yml`, environment `pypi`.
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v6
+        with:
+          python-version: "3.12"
+
+      - name: Check release tag matches package version
+        run: |
+          TAG="${GITHUB_REF_NAME#v}"
+          VERSION=$(python -c "exec(open('src/mongomig/_version.py').read()); print(__version__)")
+          if [ "$TAG" != "$VERSION" ]; then
+            echo "::error::Release tag v$TAG does not match _version.py ($VERSION)"
+            exit 1
+          fi
+
+      - name: Build sdist and wheel
+        run: uv build
+
+      - name: Smoke-test the built wheel
+        run: |
+          uv venv /tmp/smoke
+          uv pip install --python /tmp/smoke dist/*.whl
+          /tmp/smoke/bin/mongomig --version
+          cd "$(mktemp -d)" && /tmp/smoke/bin/mongomig init && /tmp/smoke/bin/mongomig history
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish:
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/mongomig
+    permissions:
+      id-token: write  # required for Trusted Publishing
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+      - uses: pypa/gh-action-pypi-publish@release/v1

mongomig-0.1.0.dev0/.gitignore

@@ -0,0 +1,218 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# 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/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+# Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+# uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+# poetry.lock
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#   JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#   be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#   and can be added to the global gitignore or merged into this file.  For a more nuclear
+#   option (not recommended) you can uncomment the following to ignore the entire idea folder.
+# .idea/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#   that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#   you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+# Temporary file for partial code execution
+tempCodeRunnerFile.py
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml

mongomig-0.1.0.dev0/CHANGELOG.md

@@ -0,0 +1,16 @@
+# Changelog
+
+All notable changes to this project are documented here. The format follows
+[Keep a Changelog](https://keepachangelog.com/en/1.1.0/) and the project uses
+[Semantic Versioning](https://semver.org/).
+
+## [Unreleased]
+
+### Added
+- Project foundation (Milestone 1): packaging, CLI, configuration with `${VAR}` interpolation
+  and environment overlays, credential redaction, MongoDB connection handling.
+- Revision files with random 12-hex ids, AST-based loading (no code execution for offline
+  commands), checksums, and a revision graph with heads, branches, merges, prefix resolution.
+- Migration tracking collection (`__mongomig_migrations`).
+- Commands: `init`, `revision`, `heads`, `history`, `current`; `--json` output everywhere.
+- Docker Compose MongoDB (single-node replica set) and CI for Python 3.11–3.13 × MongoDB 6/7/8.

mongomig-0.1.0.dev0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 aurosmruti
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

mongomig-0.1.0.dev0/Makefile

@@ -0,0 +1,33 @@
+.PHONY: install lint format typecheck test test-unit test-integration check mongo-up mongo-down
+
+install:          ## Create .venv and install mongomig with dev extras (needs uv)
+	uv venv --python 3.12 .venv
+	uv pip install -e ".[dev]"
+
+lint:
+	.venv/bin/ruff check src tests
+	.venv/bin/ruff format --check src tests
+
+format:
+	.venv/bin/ruff check --fix src tests
+	.venv/bin/ruff format src tests
+
+typecheck:
+	.venv/bin/mypy
+
+test:             ## All tests (integration tests skip if MongoDB is not running)
+	.venv/bin/pytest
+
+test-unit:
+	.venv/bin/pytest tests/unit
+
+test-integration: ## Requires `make mongo-up`
+	MONGOMIG_REQUIRE_MONGO=1 .venv/bin/pytest tests/integration
+
+check: lint typecheck test
+
+mongo-up:
+	docker compose up -d --wait
+
+mongo-down:
+	docker compose down -v

mongomig-0.1.0.dev0/PKG-INFO

@@ -0,0 +1,177 @@
+Metadata-Version: 2.5
+Name: mongomig
+Version: 0.1.0.dev0
+Summary: Alembic-style schema evolution and migrations for MongoDB.
+Project-URL: Homepage, https://github.com/anon-000/mongomig
+Project-URL: Issues, https://github.com/anon-000/mongomig/issues
+Author: aurosmruti
+License-Expression: MIT
+License-File: LICENSE
+Keywords: alembic,fastapi,migrations,mongodb,pydantic,pymongo,schema
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+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: Topic :: Database
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Requires-Dist: pydantic>=2.6
+Requires-Dist: pymongo>=4.6
+Requires-Dist: pyyaml>=6.0
+Requires-Dist: rich>=13.7
+Requires-Dist: typer>=0.12
+Provides-Extra: beanie
+Requires-Dist: beanie>=1.26; extra == 'beanie'
+Provides-Extra: dev
+Requires-Dist: mypy>=1.11; extra == 'dev'
+Requires-Dist: pytest-cov>=5.0; extra == 'dev'
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Requires-Dist: ruff>=0.6; extra == 'dev'
+Requires-Dist: types-pyyaml>=6.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# MongoMig
+
+**Alembic-style schema evolution and migrations for MongoDB.**
+
+Built for Python services (FastAPI, Flask, workers) on PyMongo, Motor or Beanie.
+
+> **Status: pre-alpha.** Milestone 1 (foundation) is done. Running migrations (`upgrade` /
+> `downgrade`), schema diff and autogenerate are coming next. See the roadmap below.
+
+```console
+$ mongomig init
+$ mongomig revision -m "add user profile"
+Created revision 7be204a1c9e0 → migrations/versions/20260924_1432_7be204a1c9e0_add_user_profile.py
+
+$ mongomig history
+a1f3c9d20b44 -> 7be204a1c9e0 (head), add user profile
+<base> -> a1f3c9d20b44, initial
+
+$ mongomig current
+Database: app
+Current:  a1f3c9d20b44  initial
+Pending:  1
+  - 7be204a1c9e0  add user profile
+```
+
+## Install
+
+```bash
+pip install mongomig          # not yet published — install from source for now
+```
+
+Requires Python 3.11+ and MongoDB 6.0+.
+
+## Quick start
+
+```bash
+mongomig init                                   # creates mongomig.yaml + migrations/
+export MONGODB_URI="mongodb://localhost:27017"
+mongomig revision -m "initial"                  # new revision file
+mongomig current                                # what's applied vs pending
+```
+
+`mongomig init` creates:
+
+```text
+mongomig.yaml                   # connection + execution settings (no secrets!)
+migrations/
+├── env.py                      # Python: points MongoMig at your models
+├── schema_snapshot.json        # last known expected schema (used by autogenerate)
+└── versions/                   # one file per revision
+```
+
+### Configuration
+
+```yaml
+database:
+  uri: ${MONGODB_URI}                 # ${VAR} and ${VAR:-default} are expanded
+  name: ${MONGODB_DATABASE:-app}
+```
+
+Per-environment overrides live in `mongomig.<env>.yaml` and are merged on top:
+
+```bash
+mongomig --env production current     # or MONGOMIG_ENV=production
+```
+
+MongoMig never prints passwords or full connection strings. It warns you if a password is
+written directly into the config file.
+
+### Revision files
+
+```python
+"""add user profile"""
+
+revision = "7be204a1c9e0"
+down_revision = "a1f3c9d20b44"
+reversible = True
+
+
+def upgrade(ctx):
+    ...
+
+
+def downgrade(ctx):
+    ...
+```
+
+Revision order comes from `down_revision`, not from the file name. Revision ids are random,
+so two developers working on separate branches never get the same id. If both branches add a
+revision, `mongomig heads` shows two heads, and `mongomig revision` refuses to continue until
+you choose a parent with `--head`.
+
+Revision ids can be shortened to a unique prefix of 4 or more characters, the same way git
+handles commit hashes.
+
+### Commands
+
+| Command | Needs MongoDB | Description |
+|---|---|---|
+| `init` | no | Create config and migrations directory |
+| `revision -m MSG [--head REV]` | no | Create a new revision |
+| `heads` | no | Show head revision(s) |
+| `history` | no | List revisions, newest first |
+| `current` | yes | Applied vs pending revisions (read-only) |
+
+Global options: `--config PATH`, `--env NAME`, `--json`, `--verbose`, `--version`.
+
+Exit codes: `0` success · `1` validation · `2` execution/connection · `3` configuration ·
+`4` revision conflict · `5` lock · `6` checksum mismatch.
+
+## Roadmap
+
+- [x] **M1 Foundation**: config, CLI, revision files, revision graph, tracking
+- [ ] **M2 Migration engine**: `upgrade`, `downgrade`, locking, `merge`, checksums, FastAPI lifespan helper
+- [ ] **M3 Schema engine**: `@collection` models, Beanie support, `inspect`, snapshots
+- [ ] **M4 Autogenerate**: `diff`, `revision --autogenerate`, index/validator diff
+- [ ] **M5 Production safety**: `--dry-run`, `plan`, batching, progress
+- [ ] **M6 Release**: `validate`, `doctor`, docs, PyPI
+
+## Development
+
+```bash
+make install        # uv venv + editable install with dev extras
+make mongo-up       # MongoDB 7 single-node replica set in Docker
+make check          # ruff + mypy --strict + pytest
+```
+
+Integration tests are skipped automatically when MongoDB isn't running. To test against another
+MongoDB version, run `MONGO_VERSION=8.0 make mongo-up`.
+
+### Releasing
+
+1. Bump `src/mongomig/_version.py` and update `CHANGELOG.md`, then merge to `main`.
+2. On GitHub, create a Release with tag `v<version>` (e.g. `v0.1.0`) and publish it.
+3. `.github/workflows/release.yml` checks that the tag matches the version, builds and
+   smoke-tests the wheel, then publishes to PyPI through Trusted Publishing.
+
+## License
+
+MIT