mongomig 0.1.0.dev0__py3-none-any.whl

mongomig-0.1.0.dev0.dist-info/METADATA

@@ -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

mongomig-0.1.0.dev0.dist-info/RECORD

@@ -0,0 +1,38 @@
+mongomig/__init__.py,sha256=1ccmw5XFf0GGjxA9nw-ypwPuPDyOwz91K1rACEmqQRY,717
+mongomig/__main__.py,sha256=9GxZQEhlyGv1bKuipdS6XdN-X551TK438DT90OHS-Qc,73
+mongomig/_version.py,sha256=qbhMh4mg2JMoCFflKwIRvApU63RR8AxvYq1OT__8sgI,27
+mongomig/errors.py,sha256=XsJCOBLK7wHvMUoVyFUfhnuwc6P0rF6an_t-M0QKT6c,2596
+mongomig/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+mongomig/cli/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+mongomig/cli/app.py,sha256=U4vrS_bxVwV3vkAL8CTja5lwtWkcyfpovAkxzwT-bhI,3970
+mongomig/cli/context.py,sha256=iVVVjMOpYJkyE_wfYUt0uA0BXZvVN1wiY9Qa-y7nofY,1296
+mongomig/cli/commands/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+mongomig/cli/commands/current.py,sha256=tNkwfCaBwquzNhCCMroTi5B0zcAVTYyFFZ3TqN5QQj8,2512
+mongomig/cli/commands/heads.py,sha256=VaSP4HrcfhCK7LxUx_K2dWRpwsHz4SilblKwFo2M4oc,1253
+mongomig/cli/commands/history.py,sha256=o54pC5CLdKSpixwAxhGw4yYfZgShAD3C896WVJA-5kE,1673
+mongomig/cli/commands/init.py,sha256=eLnR1hdBMEqGeEz51oFajWXHb892DtaFvbiRzWRV48s,2545
+mongomig/cli/commands/revision.py,sha256=U1OYzM3VW4CnHBrVAX5AUqbq_CsENLuVo5NIrmbGlwA,1441
+mongomig/config/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+mongomig/config/envpy.py,sha256=SdaKlxEuSZEwp4fvEYjT1fZ1Bij0nSxQCou8GOpcp4I,2132
+mongomig/config/loader.py,sha256=fJuznaaMxFwDdViHgmgSawchR46o9vgZ-XVGTvhezgA,6436
+mongomig/config/models.py,sha256=_B2xPgUh7PMim1AxKCfX5yddBX6hUcJfoegP_Wvf6Xw,2523
+mongomig/database/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+mongomig/database/client.py,sha256=-qsjc_7rcx_cQ6XAtsCTxj58CXegigGKHe5DfVtjIV0,3004
+mongomig/database/redact.py,sha256=s6_HcsMW1lhgCPWDqRfboa8eC-Rb4uTtMl6p0hEw3YQ,2553
+mongomig/migrations/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+mongomig/migrations/graph.py,sha256=MacpuIZ0RKMp6-67POYMGwXXlh7_5sUICWuT-UsCyZY,6477
+mongomig/migrations/revision.py,sha256=c7mM--kSRl_qTFLXWUpe8WB5pwR0jKH9o4jKLtfAx-I,3406
+mongomig/migrations/script.py,sha256=fL1ztGSlVPHLEtoJ8oWyRrPc5aICRpATJrgTdX8zLrQ,6770
+mongomig/migrations/tracker.py,sha256=dQl-hsX6V56cx2bOVR2gRLifHZbs_XLghVQcDNIvrdE,5296
+mongomig/output/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+mongomig/output/console.py,sha256=Zti5c2DcP-4suKCagi8Buz-o09uAJ33LboHP64hG8rY,2966
+mongomig/schema/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+mongomig/schema/snapshot.py,sha256=0a738FK3nj7dz5wi6bsZ2LQ7yO3usJZBXFjqdzP4CTc,1152
+mongomig/templates/env.py.tmpl,sha256=91xUrbgWgYU3DpDcrK5BjO9nxzcvhu0Or56lMOGj0WQ,644
+mongomig/templates/mongomig.yaml.tmpl,sha256=v4ftIlH7eVi3QsifOvHRY6GDmCE3mJn9IU3yMRWNaSA,713
+mongomig/templates/revision.py.tmpl,sha256=6ttwV73iPCCMtofP7Ko5cOYzR7_0qYy8zp22RToM_Xk,338
+mongomig-0.1.0.dev0.dist-info/METADATA,sha256=y0EGWI-rMU3nf-3qMpLkZZmj_yKh-Um4wxO6EuRmgyU,5811
+mongomig-0.1.0.dev0.dist-info/WHEEL,sha256=W3fkpkm7-wf9vBI5Z-7s0eWkeM-spu78I8Neb98DeEg,87
+mongomig-0.1.0.dev0.dist-info/entry_points.txt,sha256=LQNjKyb6yFDhRlVMYyx3T3EkUyT_tDeY4WbNvLGE__M,51
+mongomig-0.1.0.dev0.dist-info/licenses/LICENSE,sha256=pbKz-iBRMXj6nkDLbSiJkAdqk8m8OwP5Si4x8rIJAWE,1067
+mongomig-0.1.0.dev0.dist-info/RECORD,,

mongomig-0.1.0.dev0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.32.4
+Root-Is-Purelib: true
+Tag: py3-none-any

mongomig-0.1.0.dev0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+mongomig = mongomig.cli.app:main

mongomig-0.1.0.dev0.dist-info/licenses/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.