pylembic 0.2.0__tar.gz

pylembic-0.2.0/.coveragerc

@@ -0,0 +1,15 @@
+[run]
+source = 
+    src/pylembic
+
+    
+[report]
+exclude_lines =
+    pragma: no cover
+    if TYPE_CHECKING:
+    if __name__ == '__main__':
+    # Functions to avoid
+    def main
+    def __repr__
+    def __str__
+    @overload

pylembic-0.2.0/.github/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+<marco@marcoespinosa.com>.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

pylembic-0.2.0/.github/workflows/release.yml

@@ -0,0 +1,91 @@
+name: Create Release ✨ and Publish Python 🐍 distribution 📦 to PyPI
+
+on:
+  push:
+    branches:
+      - main
+    paths-ignore:
+      - '**/README.md'
+
+jobs:
+  bump-version:
+    name: Bump Version
+    runs-on: ubuntu-latest
+    outputs:
+      new_version: ${{ steps.bump-version-step.outputs.new_version }}
+    # Ignore version bump commits to avoid a loop
+    if: ${{ !contains(github.event.head_commit.message, '[skip ci]') }}
+    permissions:
+      contents: write  # Required to modify the input file
+    steps:
+      - name: Bump version in pyproject.toml
+        id: bump-version-step
+        uses: maekind/github-actions/.github/actions/bump-version@main
+        with:
+          file: pyproject.toml
+          gh_token: ${{ secrets.GH_TOKEN }}
+
+  create-tag:
+    name: Create Tag
+    needs: bump-version
+    runs-on: ubuntu-latest
+    # Skip if the version was not bumped yet
+    if: ${{ always() && needs.bump-version.result == 'success' && github.ref_name == 'main' }}
+    permissions:
+      contents: write
+    steps:        
+      - name: Create Git Tag
+        uses: maekind/github-actions/.github/actions/create-tag@main
+        with:
+          tag_name: v${{ needs.bump-version.outputs.new_version }}
+          title: ${{ github.event.head_commit.message }}
+          emoji: "🚀✨"
+
+  create-release:
+    name: Create Release
+    needs: [bump-version, create-tag]
+    runs-on: ubuntu-latest
+    # Skip if the version was not bumped yet
+    if: ${{ always() && needs.bump-version.result == 'success' && github.ref_name == 'main' }}
+    permissions:
+      contents: write  # Required for creating a release
+    steps:
+      - name: Create GitHub Release
+        uses: maekind/github-actions/.github/actions/create-release@main
+        with:
+          tag_name: v${{ needs.bump-version.outputs.new_version }}
+
+  build-and-publish:
+    name: Build and Publish to PyPI
+    needs: create-release
+    runs-on: ubuntu-latest
+    # Skip if the release was not created yet
+    if: ${{ always() && needs.create-release.result == 'success' && github.ref_name == 'main' }}
+    permissions:
+      contents: read  # Required to read the code for building the distribution
+      id-token: write  # Required for publishing to PyPI
+    steps:
+      - name: Build Python 🐍 Distributions 📦 
+        uses: maekind/github-actions/.github/actions/build-python-distribution@main
+        with:
+          python_version: "3.11"
+
+      - name: Publish distribution 📦 to PyPI
+        uses: maekind/github-actions/.github/actions/publish-to-pypi@main
+
+  github-release:
+    name: Sign and Upload to GitHub Release
+    needs: [bump-version, build-and-publish]
+    runs-on: ubuntu-latest
+    # Skip if the build and publish job failed
+    if: ${{ always() && needs.build-and-publish.result == 'success' && github.ref_name == 'main' }}
+    permissions:
+      contents: write  # Required to upload artifacts to the release
+      id-token: write  # Required for signing with Sigstore
+    steps:
+      - name:  >-
+          Sign the Python 🐍 distribution 📦 with Sigstore
+          and upload them to GitHub Release
+        uses: maekind/github-actions/.github/actions/github-release@main
+        with:
+          tag_name: v${{ needs.bump-version.outputs.new_version }}

pylembic-0.2.0/.github/workflows/testing.yml

@@ -0,0 +1,25 @@
+name: Pylembic testing 🧪 and coverage report generation 📝
+
+on:
+  - push
+
+jobs:
+  testing:
+    name: Python Testing and Coverage
+    runs-on: ubuntu-latest
+    steps:
+      - name: Run Python Tests
+        uses: maekind/github-actions/.github/actions/python-testing-and-coverage@main
+        with:
+          python_version: "3.11"
+          coverage_path: "./src"
+
+  upload-coverage:
+    name: Upload Coverage to Codecov
+    needs: testing
+    runs-on: ubuntu-latest
+    steps:
+      - name: Upload Code Coverage
+        uses: maekind/github-actions/.github/actions/upload-codecov-coverage@main
+        with:
+          codecov_token: ${{ secrets.CODECOV_GH_PYLEMBIC }}

pylembic-0.2.0/.gitignore

@@ -0,0 +1,159 @@
+# Coverage
+.coverage
+coverage.xml
+
+# 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/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# 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/

pylembic-0.2.0/.python-version

@@ -0,0 +1 @@
+3.11

pylembic-0.2.0/.vscode/settings.json

@@ -0,0 +1,13 @@
+{
+    "python.testing.pytestArgs": [
+        "tests"
+    ],
+    "python.testing.unittestEnabled": false,
+    "python.testing.pytestEnabled": true,
+    "editor.rulers": [
+        {
+            "column": 88,
+            "color": "#ff0000"
+        }
+    ]
+}

pylembic-0.2.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Marco Espinosa
+
+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.

pylembic-0.2.0/PKG-INFO

@@ -0,0 +1,137 @@
+Metadata-Version: 2.4
+Name: pylembic
+Version: 0.2.0
+Summary: This package provides validation for Alembic migrations.
+Author-email: Marco Espinosa <marco@marcoespinosa.com>
+License: MIT License
+        
+        Copyright (c) 2024 Marco Espinosa
+        
+        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.
+License-File: LICENSE
+Requires-Python: >=3.11
+Requires-Dist: alembic>=1.14.0
+Requires-Dist: matplotlib>=3.10.0
+Requires-Dist: networkx>=3.4.2
+Requires-Dist: typer>=0.15.1
+Description-Content-Type: text/markdown
+
+<!-- Shields -->
+<p align="center">
+<a href="https://github.com/maekind/pylembic"><img src="https://img.shields.io/github/actions/workflow/status/maekind/pylembic/.github%2Fworkflows%2Ftesting.yml?label=tests&color=green" hspace="5"></a>
+<a href="https://codecov.io/gh/maekind/pylembic"><img src="https://codecov.io/gh/maekind/pylembic/graph/badge.svg?token=JcGna50uJL" hspace="5"/>
+ </a>
+<a href="https://github.com/maekind/pylembic/releases"><img src="https://img.shields.io/github/actions/workflow/status/maekind/pylembic/.github%2Fworkflows%2Frelease.yml?label=package&color=green" hspace="5"></a>
+<a href="https://pypi.org/project/pylembic"><img src="https://img.shields.io/github/v/release/maekind/pylembic?color=blue&label=pypi latest" hspace="5"></a>
+<br>
+<a href="https://github.com/maekind/kairo/blob/main/LICENSE"><img src="https://img.shields.io/badge/License-MIT-orange.svg" hspace="5"></a>
+<a href="https://github.com/maekind/kairo"><img src="https://img.shields.io/github/repo-size/maekind/pylembic?color=red" hspace="5"></a>
+<a href="https://github.com/maekind/pylembic"><img src="https://img.shields.io/github/last-commit/maekind/pylembic?color=black" hspace="5"></a>
+<a href="https://www.python.org/downloads/"><img src="https://img.shields.io/github/languages/top/maekind/pylembic?color=darkgreen" hspace="5"></a>
+<a href="https://www.python.org/downloads/"><img src="https://img.shields.io/badge/python%20version-%3E3.11-lightblue" hspace="5"></a>
+</p>
+
+# pylembic
+
+## Description
+
+This package provides validation of Alembic migrations for Python projects.
+
+It will check:
+
+- Linearity: Ensures a clean and predictable migration chain.
+- Circular dependencies: Prevents migration failures due to loops in the
+dependency chain.
+- Orphan migrations: Identifies migrations improperly created without linking
+to any other migration.
+- Multiple bases/heads: Identifies multiple bases or heads in the migration graph.
+- Graph visualization: Provides a visual way to catch anomalies and understand the
+migration flow.
+
+## Installation
+
+You can install this package using pip:
+
+```bash
+pip install pylembic
+```
+
+## Usage
+
+### Testing
+
+You can use this module with your preferred testing framework as follows:
+
+```python
+from os import path
+
+from pytest import fixture
+
+from pylembic.migrations import Validator
+
+
+@fixture
+def with_alembic_config_path():
+    # We assume the migrations folder is at the root of the project,
+    # and this test file is in the tests folder, also at the root of the project.
+    # TODO: Feel free to adjust the path to your project's migrations folder.
+    return path.abspath(
+        path.join(path.dirname(path.dirname(__file__)), "migrations")
+    )
+
+
+def test_migrations(with_alembic_config_path):
+    migration_validator = Validator(with_alembic_config_path)
+    assert migration_validator.validate()
+```
+
+### Visualizing the migration graph
+
+You can show the migrations graph by calling the method `show_graph`:
+
+```python
+
+from os import path
+
+from pylembic.migrations import Validator
+
+alembic_config_path = path.abspath(path.join("your path", "migrations"))
+
+migration_validator = Validator(alembic_config_path)
+
+migration_validator.show_graph()
+```
+
+### Command line
+
+You can also use the command line for:
+
+- Validating migrations:
+
+    ```bash
+    pylembic ./path/to/migrations --validate
+    ```
+
+- Visualizing the migration graph:
+
+    ```bash
+    pylembic ./path/to/migrations --show-graph
+    ```
+
+(c) 2024, <a href="mailto:marco@marcoespinosa.com">Marco Espinosa</a>