django-fga-data-sync 0.1.0__tar.gz

django_fga_data_sync-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,51 @@
+name: Publish to PyPI
+
+# Trigger the workflow only when a semantic version tag is pushed.
+# This strictly prevents accidental publishes from the main branch.
+on:
+  push:
+    tags:
+      - 'v*.*.*'  # e.g., v0.1.0, v1.0.0-beta
+
+jobs:
+  build-and-publish:
+    name: Build and Publish Python Package
+    runs-on: ubuntu-latest
+    
+    # Specify the GitHub environment (helpful for deployment protection rules)
+    environment:
+      name: pypi
+      url: https://pypi.org/p/django-fga-data-sync
+    
+    # Mandatory permissions for OIDC authentication with PyPI
+    permissions:
+      id-token: write  # Required to request the OIDC JWT token
+      contents: read   # Required to perform actions/checkout
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0  # Useful if hatchling or other tools need git history for dynamic versioning
+
+      - name: Set up Python 3.12
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+
+      - name: Install build dependencies
+        # Upgrading pip and installing the standard PyPA build tool
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install build
+
+      - name: Build a binary wheel and a source tarball
+        # This will automatically use 'hatchling' as defined in pyproject.toml
+        run: python -m build
+
+      - name: Publish package distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          # Optional: Prevents the workflow from failing if you restart a job 
+          # for a version that is already uploaded.
+          skip-existing: true

django_fga_data_sync-0.1.0/.gitignore

@@ -0,0 +1,216 @@
+# 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/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml

django_fga_data_sync-0.1.0/.justfile

@@ -0,0 +1,38 @@
+# justfile
+
+# Enable automatic loading of .env file
+set dotenv-load := true
+
+# Shell configurations
+set shell := ["bash", "-c"]
+set windows-shell := ["pwsh", "-NoLogo", "-Command"]
+
+# Default recipe: show help
+default:
+    @just --list
+
+# 🤠 1. The Ultimate Install Command
+# This reads pyproject.toml, creates the venv, installs the package,
+# and installs both the 'dev' and 'docs' dependency groups instantly.
+install:
+    uv sync --group dev --group docs
+
+# 🤠 2. Run linting and formatting
+lint:
+    uv run ruff check src/
+    uv run ruff format src/
+lint-fix:
+    uv run ruff check --fix src/
+    uv run ruff format src/
+
+# 🤠 3. Serve docs (Safely inside the uv venv!)
+docs-serve:
+    uv run mkdocs serve --livereload -a 0.0.0.0:80 -w .\docs\ -w .\mkdocs.yml -w .\src\
+
+# 🤠 4. Build docs
+docs-build:
+    uv run mkdocs build
+
+# Cross-platform clean (uses Python instead of rm)
+docs-clean:
+    uv run python -c "import shutil, pathlib; shutil.rmtree('site', ignore_errors=True)"

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

@@ -0,0 +1,121 @@
+# .pre-commit-config.yaml
+# Install: pip install pre-commit && pre-commit install
+# Run manually: pre-commit run --all-files
+# Update hooks: pre-commit autoupdate
+
+default_stages: [pre-commit]
+
+# Global excludes for Django projects
+exclude: |
+  (?x)^(
+    .*/migrations/.*|
+    .*/static/.*|
+    .*/media/.*|
+    .*/.venv/.*|
+    .*\.pyc$
+  )$
+
+repos:
+  # =============================================================================
+  # General File Checks
+  # =============================================================================
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v6.0.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-yaml
+        exclude: ^mkdocs\.yml$
+      - id: check-json
+        exclude: ^\.vscode/.*\.json$
+      - id: check-toml
+      - id: check-added-large-files
+        args: ["--maxkb=500"]
+      - id: detect-private-key
+      - id: fix-byte-order-marker
+      - id: mixed-line-ending
+        args: ["--fix=lf"]
+      - id: check-merge-conflict
+      - id: check-case-conflict
+      - id: check-docstring-first
+      - id: debug-statements  # Catches breakpoint(), pdb, etc.
+      # Prevent direct commits to main (allow version tags)
+      - id: no-commit-to-branch
+        args: [--branch, main, --pattern, '^v\d+\.\d+\.\d+.*$']
+
+  # =============================================================================
+  # Python Linting & Formatting (Ruff)
+  # Replaces: Black, isort, flake8, pyupgrade
+  # =============================================================================
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.15.4
+    hooks:
+      - id: ruff
+        args: [--fix, --exit-non-zero-on-fix]
+        types_or: [python, pyi, jupyter]
+      - id: ruff-format
+        types_or: [python, pyi, jupyter]
+
+  # =============================================================================
+  # Django Template Linting
+  # =============================================================================
+  - repo: https://github.com/djlint/djLint
+    rev: v1.36.4
+    hooks:
+      - id: djlint-reformat-django
+      - id: djlint-django
+
+  # =============================================================================
+  # Django Syntax Upgrades
+  # =============================================================================
+  - repo: https://github.com/adamchainz/django-upgrade
+    rev: '1.30.0'
+    hooks:
+      - id: django-upgrade
+        args: [--target-version, "5.2"]  # Set to your Django version
+
+  # =============================================================================
+  # Type Checking (Mypy)
+  # =============================================================================
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.19.1
+    hooks:
+      - id: mypy
+        # Adjust 'files' to match your project source directory
+        files: ^src/
+        # Migrations are auto-generated; exclude them to save time
+        exclude: ^src/.*/migrations/
+        args: [
+          "--no-error-summary",
+          "--show-error-codes",
+          "--namespace-packages",
+          "--explicit-package-bases",
+          "--config-file=mypy-pre-commit.ini",
+          "--no-error-summary",
+          "--show-error-codes"
+        ]
+        additional_dependencies:
+          - "types-requests"
+          - "django-environ>=0.11.0"
+          - "types-PyYAML"
+          - "python-dotenv>=1.0.0"
+          - "pytest"
+
+  # =============================================================================
+  # Security Scanning
+  # =============================================================================
+  - repo: https://github.com/PyCQA/bandit
+    rev: 1.9.4
+    hooks:
+      - id: bandit
+        args: ["-c", "pyproject.toml"]
+        additional_dependencies: ["bandit[toml]"]
+
+  # =============================================================================
+  # Commit Message Linting
+  # =============================================================================
+  - repo: https://github.com/commitizen-tools/commitizen
+    rev: v4.13.9
+    hooks:
+      - id: commitizen
+        stages: [commit-msg]