django-graphex 1.0.0__tar.gz

django_graphex-1.0.0/.github/workflows/cicd.yaml

@@ -0,0 +1,358 @@
+name: Continuous Integration & Delivery
+
+on:
+  push:
+    branches:
+    - main
+    tags:
+    - 'v*.*.*'
+  pull_request:
+    branches:
+    - main
+  workflow_dispatch:
+    inputs:
+      repository:
+        description: "Choose repository to publish"
+        required: true
+        default: "testpypi"
+        type: choice
+        options:
+        - testpypi
+        - pypi
+
+permissions:
+  contents: write
+  packages: write
+  pull-requests: read
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+        # Python 3.12 — Django floor is declared >=4.0 but CI tests from 4.2 (SPEC OQ2)
+        - python-version: '3.12'
+          toxenv: 'py312-django42'
+        - python-version: '3.12'
+          toxenv: 'py312-django50'
+        - python-version: '3.12'
+          toxenv: 'py312-django51'
+        - python-version: '3.12'
+          toxenv: 'py312-django52'
+        - python-version: '3.12'
+          toxenv: 'py312-django60'
+        # Python 3.13
+        - python-version: '3.13'
+          toxenv: 'py313-django42'
+        - python-version: '3.13'
+          toxenv: 'py313-django50'
+        - python-version: '3.13'
+          toxenv: 'py313-django51'
+        - python-version: '3.13'
+          toxenv: 'py313-django52'
+        - python-version: '3.13'
+          toxenv: 'py313-django60'
+        # Python 3.14
+        - python-version: '3.14-dev'
+          toxenv: 'py314-django42'
+        - python-version: '3.14-dev'
+          toxenv: 'py314-django50'
+        - python-version: '3.14-dev'
+          toxenv: 'py314-django51'
+        - python-version: '3.14-dev'
+          toxenv: 'py314-django52'
+        - python-version: '3.14-dev'
+          toxenv: 'py314-django60'
+
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v6
+
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v6
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Install uv
+      uses: astral-sh/setup-uv@v7
+      with:
+        enable-cache: true
+
+    - name: Run tests
+      run: uvx --with tox-uv tox -e ${{ matrix.toxenv }}
+
+    - name: Upload test results
+      uses: actions/upload-artifact@v7
+      if: failure()
+      with:
+        name: test-results-${{ matrix.toxenv }}
+        path: .tox/*/log/
+
+  base-install:
+    # Proves the base install (no [subscriptions] extra) never imports channels.
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v6
+
+    - name: Set up Python
+      uses: actions/setup-python@v6
+      with:
+        python-version: '3.12'
+
+    - name: Install uv
+      uses: astral-sh/setup-uv@v7
+      with:
+        enable-cache: true
+
+    - name: Assert channels is absent without the extra
+      run: uvx --with tox-uv tox -e base-install
+
+  lint-and-security:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v6
+
+    - name: Set up Python
+      uses: actions/setup-python@v6
+      with:
+        python-version: '3.12'
+
+    - name: Install uv
+      uses: astral-sh/setup-uv@v7
+      with:
+        enable-cache: true
+
+    - name: Run code quality checks
+      run: uvx --with tox-uv tox -e quality
+
+    - name: Run security checks
+      run: uvx --with tox-uv tox -e security
+
+  coverage:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v6
+
+    - name: Set up Python
+      uses: actions/setup-python@v6
+      with:
+        python-version: '3.12'
+
+    - name: Install uv
+      uses: astral-sh/setup-uv@v7
+      with:
+        enable-cache: true
+
+    - name: Run tests with coverage
+      run: |
+        uv sync
+        uv run coverage run -m pytest
+        uv run coverage xml
+        uv run coverage report
+
+    - name: Upload coverage to Codecov
+      uses: codecov/codecov-action@v7
+      with:
+        files: ./coverage.xml
+        fail_ci_if_error: false
+        verbose: true
+
+  get-version:
+    runs-on: ubuntu-latest
+    outputs:
+      version: ${{ steps.get_version.outputs.version }}
+      is_prerelease: ${{ steps.get_version.outputs.is_prerelease }}
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v6
+
+    - name: Set up Python
+      uses: actions/setup-python@v6
+      with:
+        python-version: '3.12'
+
+    - name: Get version from pyproject.toml
+      id: get_version
+      run: |
+        VERSION=$(python -c "import tomllib; print(tomllib.load(open('pyproject.toml','rb'))['project']['version'])")
+        echo "version=$VERSION" >> $GITHUB_OUTPUT
+
+        if [[ $VERSION =~ (alpha|beta|rc|dev) ]]; then
+          echo "is_prerelease=true" >> $GITHUB_OUTPUT
+        else
+          echo "is_prerelease=false" >> $GITHUB_OUTPUT
+        fi
+
+        echo "Detected version: $VERSION"
+
+  publish:
+    needs: [ test, lint-and-security, coverage, get-version ]
+    runs-on: ubuntu-latest
+    # Publish only when a version tag is pushed, or when triggered manually.
+    if: |
+      startsWith(github.ref, 'refs/tags/v') ||
+      github.event_name == 'workflow_dispatch'
+    environment:
+      name: ${{ startsWith(github.ref, 'refs/tags/v') && 'production' || 'staging' }}
+
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v6
+      with:
+        fetch-depth: 0
+
+    - name: Install uv
+      uses: astral-sh/setup-uv@v7
+      with:
+        enable-cache: true
+
+    - name: Determine target repository
+      id: target_repo
+      run: |
+        # A pushed tag publishes to PyPI; a manual run uses the chosen repo.
+        if [ "${{ github.event_name }}" == "workflow_dispatch" ]; then
+          REPO="${{ github.event.inputs.repository }}"
+        else
+          REPO="pypi"
+        fi
+
+        echo "repository=$REPO" >> $GITHUB_OUTPUT
+        echo "Publishing to: $REPO"
+
+    - name: Verify the tag matches the package version
+      if: startsWith(github.ref, 'refs/tags/v')
+      run: |
+        TAG_VERSION="${GITHUB_REF_NAME#v}"
+        PKG_VERSION="${{ needs.get-version.outputs.version }}"
+        if [ "$TAG_VERSION" != "$PKG_VERSION" ]; then
+          echo "::error::Tag ${GITHUB_REF_NAME} does not match pyproject.toml version ${PKG_VERSION}."
+          exit 1
+        fi
+        echo "Tag matches package version: $PKG_VERSION"
+
+    - name: Build package
+      run: uv build
+
+    - name: Publish to PyPI
+      if: steps.target_repo.outputs.repository == 'pypi'
+      run: uv publish --token ${{ secrets.PYPI_TOKEN }}
+
+    - name: Publish to TestPyPI
+      if: steps.target_repo.outputs.repository == 'testpypi'
+      run: uv publish --publish-url https://test.pypi.org/legacy/ --token ${{ secrets.TESTPYPI_TOKEN }}
+
+  create-release:
+    needs: [ publish, get-version ]
+    runs-on: ubuntu-latest
+    # Only cut a GitHub Release for a real version tag.
+    if: |
+      needs.publish.result == 'success' &&
+      startsWith(github.ref, 'refs/tags/v')
+
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v6
+      with:
+        fetch-depth: 0
+
+    - name: Generate changelog
+      id: changelog
+      run: |
+        VERSION="${{ needs.get-version.outputs.version }}"
+        TAG_NAME="v$VERSION"
+
+        PREVIOUS_TAG=$(git tag --sort=-version:refname | grep -E '^v[0-9]+\.[0-9]+\.[0-9]+' | sed -n '2p')
+
+        if [ -z "$PREVIOUS_TAG" ]; then
+          echo "No previous tag found, generating changelog from first commit"
+          CHANGELOG=$(git log --pretty=format:"- %s (%h)" --no-merges)
+        else
+          echo "Generating changelog from $PREVIOUS_TAG to $TAG_NAME"
+          CHANGELOG=$(git log $PREVIOUS_TAG..HEAD --pretty=format:"- %s (%h)" --no-merges)
+        fi
+
+        if [ -z "$CHANGELOG" ]; then
+          CHANGELOG="- Initial release"
+        fi
+
+        cat << EOF > changelog.md
+        ## What's Changed
+
+        $CHANGELOG
+
+        ## Installation
+
+        \`\`\`bash
+        pip install django-graphex==$VERSION
+        \`\`\`
+
+        **Full Changelog**: https://github.com/${{ github.repository }}/compare/$PREVIOUS_TAG...$TAG_NAME
+        EOF
+
+    - name: Create GitHub Release
+      uses: softprops/action-gh-release@v3
+      with:
+        tag_name: v${{ needs.get-version.outputs.version }}
+        name: Release v${{ needs.get-version.outputs.version }}
+        body_path: changelog.md
+        draft: false
+        prerelease: ${{ needs.get-version.outputs.is_prerelease == 'true' }}
+        files: |
+          dist/*
+        generate_release_notes: true
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+    - name: Release summary
+      run: |
+        echo "✅ Release v${{ needs.get-version.outputs.version }} created successfully!"
+        echo "🔗 https://github.com/${{ github.repository }}/releases/tag/v${{ needs.get-version.outputs.version }}"
+
+  deploy-docs:
+    # Build and publish the documentation to GitHub Pages, but only after the
+    # package was successfully published to PyPI for this version tag.
+    needs: [ publish ]
+    runs-on: ubuntu-latest
+    if: startsWith(github.ref, 'refs/tags/v')
+    permissions:
+      contents: read
+      pages: write
+      id-token: write
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    concurrency:
+      group: "pages"
+      cancel-in-progress: false
+
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v6
+
+    - name: Install uv
+      uses: astral-sh/setup-uv@v7
+      with:
+        enable-cache: true
+
+    - name: Install dependencies
+      run: uv sync
+
+    - name: Build documentation
+      run: uv run zensical build --clean -f zensical.yml
+
+    - name: Setup Pages
+      uses: actions/configure-pages@v6
+
+    - name: Upload artifact
+      uses: actions/upload-pages-artifact@v5
+      with:
+        path: ./site
+
+    - name: Deploy to GitHub Pages
+      id: deployment
+      uses: actions/deploy-pages@v5

django_graphex-1.0.0/.github/workflows/docs.yml

@@ -0,0 +1,61 @@
+name: Documentation (manual)
+
+# Automatic docs deployment happens in the release pipeline (cicd.yaml's
+# `deploy-docs` job, which runs after a successful PyPI publish on a version
+# tag). This workflow is only for rebuilding/redeploying the docs on demand
+# (e.g. a docs-only fix between releases).
+on:
+  workflow_dispatch:  # Manual trigger only
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v6
+
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: '3.12'
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v7
+        with:
+          enable-cache: true
+
+      - name: Install dependencies
+        run: uv sync
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v6
+
+      - name: Build documentation
+        run: uv run zensical build --clean -f zensical.yml
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v5
+        with:
+          path: ./site
+
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v5

django_graphex-1.0.0/.gitignore

@@ -0,0 +1,184 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+*.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/
+
+# 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/
+
+# MkDocs documentation
+site/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+Pipfile.lock
+
+# PEP 582
+__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/
+
+# IDEs
+.idea/
+.vscode/
+*.swp
+*.swo
+*~
+
+# OS generated files
+.DS_Store
+.DS_Store?
+._*
+.Spotlight-V100
+.Trashes
+ehthumbs.db
+Thumbs.db
+
+# Security reports
+bandit-report.json
+
+# Poetry virtual environments
+# Note: poetry.lock should be committed to ensure reproducible builds
+
+# Temporary files
+*.tmp
+*.temp
+
+# Log files
+*.log
+
+# Database files
+*.sqlite3
+*.db
+
+# Project-specific
+.flake8
+
+# Editor and system files
+*.sublime-project
+*.sublime-workspace
+.vscode/settings.json
+.vscode/launch.json
+.vscode/extensions.json
+
+# Coverage HTML reports
+htmlcov/
+
+# Documentation builds
+docs/site/
+docs/_build/
+
+# Backup files
+*.bak
+*.backup
+*~
+
+# MacOS specific
+.DS_Store
+.AppleDouble
+.LSOverride

django_graphex-1.0.0/.pre-commit-config.yaml

@@ -0,0 +1,51 @@
+repos:
+  - repo: https://github.com/commitizen-tools/commitizen
+    rev: v4.9.0
+    hooks:
+      - id: commitizen
+        stages:
+          - commit-msg
+
+  # Lint + format with ruff (replaces isort, black, flake8 and autoflake).
+  # Configuration (rule selection, per-file ignores, pydocstyle convention) is
+  # read from pyproject.toml's [tool.ruff] section, so `examples/*` and
+  # `tests/*` are exempt from docstring (D) rules here too.
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.13.1
+    hooks:
+      - id: ruff
+        args:
+          - --fix
+      - id: ruff-format
+
+  # Generic hygiene hooks.
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v6.0.0
+    hooks:
+      - id: check-yaml
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+      - id: check-merge-conflict
+      - id: check-added-large-files
+      - id: check-case-conflict
+      - id: debug-statements
+
+  # Security checks (library code only).
+  - repo: https://github.com/PyCQA/bandit
+    rev: 1.8.6
+    hooks:
+      - id: bandit
+        args:
+          - --skip=B101,B311,B324
+          - --exclude=tests,migrations
+        files: ^django_graphex/
+
+  # Type checking (library code only).
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.17.1
+    hooks:
+      - id: mypy
+        additional_dependencies:
+          - types-six
+          - types-python-dateutil
+        files: ^django_graphex/

django_graphex-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Ernesto Perez Amigo
+
+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_graphex-1.0.0/MANIFEST.in

@@ -0,0 +1,3 @@
+include README.md
+include README.rst
+include LICENSE