django-migration-zero 0.1.0__tar.gz

django_migration_zero-0.1.0/.ambient-package-update/metadata.py

@@ -0,0 +1,63 @@
+from ambient_package_update.metadata.author import PackageAuthor
+from ambient_package_update.metadata.constants import DEV_DEPENDENCIES, LICENSE_MIT
+from ambient_package_update.metadata.package import PackageMetadata
+from ambient_package_update.metadata.readme import ReadmeContent
+
+METADATA = PackageMetadata(
+    package_name='django_migration_zero',
+    authors=[
+        PackageAuthor(
+            name='Ambient Digital',
+            email='hello@ambient.digital',
+        ),
+    ],
+    company='Ambient Innovation: GmbH',
+    license=LICENSE_MIT,
+    license_year=2023,
+    development_status='4 - Beta',
+    readme_content=ReadmeContent(
+        tagline="""Welcome to **django-migration-zero** - the holistic implementation of "migration zero" pattern for
+        Django covering local changes and CI/CD pipeline adjustments.
+
+This package implements the "migration zero" pattern to clean up your local migrations and provides convenient
+management commands to recreate your migration files and updating your migration history on your environments
+(like test or production systems).""",
+        content="""## Features
+
+* Remove all existing local migration files and recreate them as initial migrations
+* Configuration singleton in Django admin to prepare your clean-up deployment
+* Management command for your pipeline to update Django's migration history table to reflect the changed migrations
+
+## Motivation
+
+Working with any proper ORM will result in database changes which are reflected in migration files to update your
+different environment's database structure. These files are versioned in your repository and if you follow any of the
+most popular deployment approaches, they won't be needed when they are deployed on production. This means, they clutter
+your repo, might lead to merge conflicts in the future and will slow down your test setup.
+
+Django's default way of handling this is called "squashing". This approach is covered broadly in the
+(official documentation)[https://docs.djangoproject.com/en/dev/topics/migrations/#migration-squashing. The main
+drawback here is, that you have to take care of circular dependencies between models. Depending on your project's
+size, this can take a fair amount of time.
+
+The main benefit of squashing migrations is, that the history stays intact, therefore it can be used for example in
+package which can be installed by anybody and you don't have control over their database.
+
+If you are working on a "regular" application, you have full control over your data(bases) and once everything has
+been applied on the "last" system, typically production, the migrations are obsolete. To avoid spending much time on
+fixing squashed migrations you won't need, you can use the "migration zero" pattern. In a nutshell, this means:
+
+* Delete all your local migration files
+* Recreate initial migration files containing your current model state
+* Fix the migration history on every of your environments""",
+    ),
+    dependencies=[
+        'Django>=3.2',
+    ],
+    optional_dependencies={
+        'dev': [
+            *DEV_DEPENDENCIES,
+        ],
+    },
+    ruff_ignore_list=[],
+)

django_migration_zero-0.1.0/.coveragerc

@@ -0,0 +1,7 @@
+[run]
+omit =
+  setup.py,
+  *_test.py,
+  tests.py,
+  *tests*,
+  conftest.py

django_migration_zero-0.1.0/.editorconfig

@@ -0,0 +1,18 @@
+# http://editorconfig.org
+
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.{py,rst,ini}]
+indent_style = space
+indent_size = 4
+ij_continuation_indent_size = 8
+
+[*.yml]
+indent_style = space
+indent_size = 2

django_migration_zero-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,51 @@
+name: Unit tests
+
+on:
+  push:
+    branches: [ '**' ]
+
+jobs:
+  linting:
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Set up Python 3.12
+        uses: actions/setup-python@v3
+        with:
+          python-version: "3.12"
+
+      - name: Install required packages
+        run: pip install pre-commit
+
+      - name: Run pre-commit hooks
+        run: pre-commit run --all-files --hook-stage push
+
+  build:
+    name: Python ${{ matrix.python-version }}, django ${{ matrix.django-version }}
+    runs-on: ubuntu-22.04
+    strategy:
+      matrix:
+        python-version: [3.8, 3.9, '3.10', '3.11', '3.12']
+        django-version: [32, 41, 42]
+
+        exclude:
+          - python-version: '3.12'
+            django-version: 32
+          - python-version: '3.11'
+            django-version: 32
+          - python-version: '3.10'
+            django-version: 32
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: setup python
+        uses: actions/setup-python@v3
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install tox
+        run: pip install tox
+      - name: Run Tests
+        env:
+          TOXENV: django${{ matrix.django-version }}
+        run: tox

django_migration_zero-0.1.0/.gitignore

@@ -0,0 +1,160 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$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
+
+# 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
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.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/

django_migration_zero-0.1.0/.pre-commit-config.yaml

@@ -0,0 +1,30 @@
+# you find the full pre-commit-tools docu under:
+# https://pre-commit.com/
+
+repos:
+  - repo: https://github.com/psf/black-pre-commit-mirror
+    rev: 23.9.1
+    hooks:
+      - id: black
+        args: [ --check, --diff, --config, ./pyproject.toml ]
+        stages: [ push ]
+
+  - repo: https://github.com/charliermarsh/ruff-pre-commit
+    rev: 'v0.0.292'
+    hooks:
+      - id: ruff
+        args: [ --fix, --exit-non-zero-on-fix ]
+
+  - repo: https://github.com/asottile/pyupgrade
+    rev: v3.14.0
+    hooks:
+      - id: pyupgrade
+        args: [ --py38-plus ]
+        stages: [ push ]
+
+  - repo: https://github.com/adamchainz/django-upgrade
+    rev: 1.15.0
+    hooks:
+      - id: django-upgrade
+        args: [--target-version, "3.2"]
+        stages: [ push ]

django_migration_zero-0.1.0/.readthedocs.yml

@@ -0,0 +1,24 @@
+# .readthedocs.yml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the version of Python and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+   configuration: docs/conf.py
+
+# Optionally declare the Python requirements required to build your docs
+python:
+  install:
+    - method: pip
+      path: .
+      extra_requirements:
+        - dev

django_migration_zero-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Ambient Digital
+
+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.

django_migration_zero-0.1.0/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Ambient Innovation: GmbH
+
+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.

django_migration_zero-0.1.0/MANIFEST.in

@@ -0,0 +1,4 @@
+include README.md
+include LICENSE.md
+recursive-exclude * *.pyc
+recursive-include django_migration_zero *.py *.html *.js *.cfg *.mo *.po

django_migration_zero-0.1.0/PKG-INFO

@@ -0,0 +1,222 @@
+Metadata-Version: 2.1
+Name: django-migration-zero
+Version: 0.1.0
+Summary: Holistic implementation of "migration zero" pattern for Django covering local changes and in-production database
+Author-email: Ambient Digital <hello@ambient.digital>
+Description-Content-Type: text/markdown
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Web Environment
+Classifier: Framework :: Django
+Classifier: Framework :: Django :: 3.2
+Classifier: Framework :: Django :: 4.1
+Classifier: Framework :: Django :: 4.2
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Utilities
+Requires-Dist: Django>=3.2
+Requires-Dist: freezegun~=1.2 ; extra == "dev"
+Requires-Dist: pytest-django~=4.5 ; extra == "dev"
+Requires-Dist: pytest-mock~=3.10 ; extra == "dev"
+Requires-Dist: pre-commit~=3.2 ; extra == "dev"
+Requires-Dist: black~=23.3 ; extra == "dev"
+Requires-Dist: Django~=3.2 ; extra == "dev"
+Requires-Dist: sphinx==4.2.0 ; extra == "dev"
+Requires-Dist: sphinx-rtd-theme==1.0.0 ; extra == "dev"
+Requires-Dist: m2r2==0.3.1 ; extra == "dev"
+Requires-Dist: mistune<2.0.0 ; extra == "dev"
+Requires-Dist: ambient-package-update~=23.10.1 ; extra == "dev"
+Project-URL: Bugtracker, https://github.com/ambient-innovation/django-migration-zero/issues
+Project-URL: Changelog, https://django-migration-zero.readthedocs.io/en/latest/features/changelog.html
+Project-URL: Documentation, https://django-migration-zero.readthedocs.io/en/latest/index.html
+Project-URL: Homepage, https://github.com/ambient-innovation/django-migration-zero/
+Project-URL: Maintained by, https://ambient.digital/
+Provides-Extra: dev
+
+[![PyPI release](https://img.shields.io/pypi/v/django-migration-zero.svg)](https://pypi.org/project/django-migration-zero/)
+[![Downloads](https://static.pepy.tech/badge/django-migration-zero)](https://pepy.tech/project/django-migration-zero)
+[![Linting](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+[![Coding Style](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/python/black)
+[![Documentation Status](https://readthedocs.org/projects/django-migration-zero/badge/?version=latest)](https://django-migration-zero.readthedocs.io/en/latest/?badge=latest)
+
+Welcome to **django-migration-zero** - the holistic implementation of "migration zero" pattern for
+        Django covering local changes and CI/CD pipeline adjustments.
+
+This package implements the "migration zero" pattern to clean up your local migrations and provides convenient
+management commands to recreate your migration files and updating your migration history on your environments
+(like test or production systems).
+
+* [PyPI](https://pypi.org/project/django-migration-zero/)
+* [GitHub](https://github.com/ambient-innovation/django-migration-zero)
+* [Full documentation](https://django-migration-zero.readthedocs.io/en/latest/index.html)
+* Creator & Maintainer: [Ambient Digital](https://ambient.digital)
+
+## Features
+
+* Remove all existing local migration files and recreate them as initial migrations
+* Configuration singleton in Django admin to prepare your clean-up deployment
+* Management command for your pipeline to update Django's migration history table to reflect the changed migrations
+
+## Motivation
+
+Working with any proper ORM will result in database changes which are reflected in migration files to update your
+different environment's database structure. These files are versioned in your repository and if you follow any of the
+most popular deployment approaches, they won't be needed when they are deployed on production. This means, they clutter
+your repo, might lead to merge conflicts in the future and will slow down your test setup.
+
+Django's default way of handling this is called "squashing". This approach is covered broadly in the
+(official documentation)[https://docs.djangoproject.com/en/dev/topics/migrations/#migration-squashing. The main
+drawback here is, that you have to take care of circular dependencies between models. Depending on your project's
+size, this can take a fair amount of time.
+
+The main benefit of squashing migrations is, that the history stays intact, therefore it can be used for example in
+package which can be installed by anybody and you don't have control over their database.
+
+If you are working on a "regular" application, you have full control over your data(bases) and once everything has
+been applied on the "last" system, typically production, the migrations are obsolete. To avoid spending much time on
+fixing squashed migrations you won't need, you can use the "migration zero" pattern. In a nutshell, this means:
+
+* Delete all your local migration files
+* Recreate initial migration files containing your current model state
+* Fix the migration history on every of your environments
+
+
+
+
+## Installation
+
+
+- Install the package via pip:
+
+  `pip install django-migration-zero`
+
+  or via pipenv:
+
+  `pipenv install django-migration-zero`
+
+- Add module to `INSTALLED_APPS` within the main django `settings.py`:
+
+    ````
+    INSTALLED_APPS = (
+        ...
+        'django_migration_zero',
+    )
+     ````
+
+
+## Contribute
+
+### Setup package for development
+
+- Create a Python virtualenv and activate it
+- Install "pip-tools" with `pip install pip-tools`
+- Compile the requirements with `pip-compile --extra dev, -o requirements.txt pyproject.toml --resolver=backtracking`
+- Sync the dependencies with your virtualenv with `pip-sync`
+
+### Add functionality
+
+- Create a new branch for your feature
+- Change the dependency in your requirements.txt to a local (editable) one that points to your local file system:
+  `-e /Users/workspace/django-migration-zero` or via pip  `pip install -e /Users/workspace/django-migration-zero`
+- Ensure the code passes the tests
+- Create a pull request
+
+### Run tests
+
+- Run tests
+  ````
+  pytest --ds settings tests
+  ````
+
+### Git hooks (via pre-commit)
+
+We use pre-push hooks to ensure that only linted code reaches our remote repository and pipelines aren't triggered in
+vain.
+
+To enable the configured pre-push hooks, you need to [install](https://pre-commit.com/) pre-commit and run once:
+
+    pre-commit install -t pre-push -t pre-commit --install-hooks
+
+This will permanently install the git hooks for both, frontend and backend, in your local
+[`.git/hooks`](./.git/hooks) folder.
+The hooks are configured in the [`.pre-commit-config.yaml`](templates/.pre-commit-config.yaml.tpl).
+
+You can check whether hooks work as intended using the [run](https://pre-commit.com/#pre-commit-run) command:
+
+    pre-commit run [hook-id] [options]
+
+Example: run single hook
+
+    pre-commit run ruff --all-files --hook-stage push
+
+Example: run all hooks of pre-push stage
+
+    pre-commit run --all-files --hook-stage push
+
+### Update documentation
+
+- To build the documentation run: `sphinx-build docs/ docs/_build/html/`.
+- Open `docs/_build/html/index.html` to see the documentation.
+
+### Translation files
+
+If you have added custom text, make sure to wrap it in `_()` where `_` is
+gettext_lazy (`from django.utils.translation import gettext_lazy as _`).
+
+How to create translation file:
+
+* Navigate to `django-migration-zero`
+* `python manage.py makemessages -l de`
+* Have a look at the new/changed files within `django_migration_zero/locale`
+
+How to compile translation files:
+
+* Navigate to `django-migration-zero`
+* `python manage.py compilemessages`
+* Have a look at the new/changed files within `django_migration_zero/locale`
+
+### Publish to ReadTheDocs.io
+
+- Fetch the latest changes in GitHub mirror and push them
+- Trigger new build at ReadTheDocs.io (follow instructions in admin panel at RTD) if the GitHub webhook is not yet set
+  up.
+
+### Publish to PyPi
+
+- Update documentation about new/changed functionality
+
+- Update the `Changelog`
+
+- Increment version in main `__init__.py`
+
+- Create pull request / merge to master
+
+- This project uses the flit package to publish to PyPI. Thus publishing should be as easy as running:
+  ```
+  flit publish
+  ```
+
+  To publish to TestPyPI use the following ensure that you have set up your .pypirc as
+  shown [here](https://flit.readthedocs.io/en/latest/upload.html#using-pypirc) and use the following command:
+
+  ```
+  flit publish --repository testpypi
+  ```
+
+### Maintenance
+
+Please note that this package supports the [ambient-package-update](https://pypi.org/project/ambient-package-update/).
+So you don't have to worry about the maintenance of this package. All important configuration and setup files are
+being rendered by this updater. It works similar to well-known updaters like `pyupgrade` or `django-upgrade`.
+
+To run an update, refer to the [documentation page](https://pypi.org/project/ambient-package-update/)
+of the "ambient-package-update".
+