annot8 0.12.1__tar.gz

annot8-0.12.1/.github/workflows/publish.yml

@@ -0,0 +1,66 @@
+# File: .github/workflows/publish.yml
+
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published]
+  workflow_dispatch:
+    inputs:
+      version:
+        description: 'Version to publish (e.g., 0.10.0)'
+        required: true
+        type: string
+      test_pypi:
+        description: 'Publish to TestPyPI instead'
+        required: false
+        default: false
+        type: boolean
+
+jobs:
+  build-and-publish:
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+    permissions:
+      contents: read
+      id-token: write  # For trusted publishing
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0  # Required for setuptools_scm
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Install build dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install build twine
+
+      - name: Build package
+        run: |
+          python -m build
+
+      - name: Check package
+        run: |
+          twine check dist/*
+
+      - name: Publish to TestPyPI (if requested)
+        if: github.event.inputs.test_pypi == 'true'
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          repository-url: https://test.pypi.org/legacy/
+          # For TestPyPI, you may need to use an API token
+          # Set TEST_PYPI_API_TOKEN in repository secrets
+          password: ${{ secrets.TEST_PYPI_API_TOKEN }}
+
+      - name: Publish to PyPI
+        if: github.event.inputs.test_pypi != 'true'
+        uses: pypa/gh-action-pypi-publish@release/v1
+        # Uses trusted publishing (OIDC) - no password needed
+        # Configure in PyPI account settings → Account settings → Trusted publishers

annot8-0.12.1/.github/workflows/python-package.yml

@@ -0,0 +1,56 @@
+# File: .github/workflows/python-package.yml
+
+name: Python Package
+
+on:
+  push:
+    branches: [main, master]
+  pull_request:
+    branches: [main, master]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12", "3.13"]
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install flake8 pytest pytest-cov black pylint
+          if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+          if [ -f requirements-dev.txt ]; then pip install -r requirements-dev.txt; fi
+          pip install -e .
+
+      - name: Format with black
+        run: |
+          black --check .
+
+      - name: Lint with flake8
+        run: |
+          # stop the build if there are Python syntax errors or undefined names
+          flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
+          # exit-zero treats all errors as warnings
+          flake8 . --count --exit-zero --max-complexity=10 --max-line-length=100 --statistics
+
+      - name: Lint with pylint
+        run: |
+          pylint src tests --disable=C0111,R0913,R0914,C0103
+
+      - name: Test with pytest
+        run: |
+          pytest --cov=annot8 tests/
+
+      - name: Upload coverage report
+        uses: codecov/codecov-action@v3
+        with:
+          fail_ci_if_error: false

annot8-0.12.1/.github/workflows/workflow.yml

@@ -0,0 +1,120 @@
+# File: .github/workflows/workflow.yml
+
+name: CI/CD Workflow
+
+on:
+  push:
+    branches: [main, master]
+  pull_request:
+    branches: [main, master]
+  release:
+    types: [published]
+  workflow_dispatch:
+    inputs:
+      version:
+        description: 'Version to publish (e.g., 0.11.0)'
+        required: false
+        type: string
+      test_pypi:
+        description: 'Publish to TestPyPI instead'
+        required: false
+        default: false
+        type: boolean
+
+jobs:
+  test:
+    name: Test and Lint
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12", "3.13"]
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install flake8 pytest pytest-cov black pylint
+          if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+          if [ -f requirements-dev.txt ]; then pip install -r requirements-dev.txt; fi
+          pip install -e .
+
+      - name: Format with black
+        run: |
+          black --check .
+
+      - name: Lint with flake8
+        run: |
+          flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
+          flake8 . --count --exit-zero --max-complexity=10 --max-line-length=100 --statistics
+
+      - name: Lint with pylint
+        run: |
+          pylint src tests --disable=C0111,R0913,R0914,C0103
+
+      - name: Test with pytest
+        run: |
+          pytest --cov=annot8 tests/
+
+      - name: Upload coverage report
+        uses: codecov/codecov-action@v3
+        with:
+          fail_ci_if_error: false
+
+  publish:
+    name: Publish to PyPI
+    runs-on: ubuntu-latest
+    needs: test
+    if: github.event_name == 'release' || (github.event_name == 'workflow_dispatch' && github.event.inputs.version)
+    environment:
+      name: pypi
+    permissions:
+      contents: read
+      id-token: write  # For trusted publishing
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0  # Required for setuptools_scm
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Install build dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install build twine
+
+      - name: Build package
+        run: |
+          python -m build
+
+      - name: Check package
+        run: |
+          twine check dist/*
+
+      - name: Publish to TestPyPI (if requested)
+        if: github.event.inputs.test_pypi == 'true'
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          repository-url: https://test.pypi.org/legacy/
+          # For TestPyPI, you may need to use an API token
+          # Set TEST_PYPI_API_TOKEN in repository secrets
+          password: ${{ secrets.TEST_PYPI_API_TOKEN }}
+
+      - name: Publish to PyPI
+        if: github.event.inputs.test_pypi != 'true'
+        uses: pypa/gh-action-pypi-publish@release/v1
+        # Uses trusted publishing (OIDC) - no password needed
+        # Configure in PyPI account settings → Account settings → Trusted publishers

annot8-0.12.1/.gitignore

@@ -0,0 +1,212 @@
+# File: .gitignore
+# 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
+
+# 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
+
+# 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/
+
+# 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/
+
+# PyPI configuration file
+.pypirc
+
+# Custom
+tree.txt
+test.txt
+pytest.txt
+pylint.txt
+# General
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+black.txt
+
+.github/*.md
+
+.cursor/
+CLAUDE.md

annot8-0.12.1/.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+    "python-envs.defaultEnvManager": "ms-python.python:venv"
+}

annot8-0.12.1/CHANGELOG.md

@@ -0,0 +1,100 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.12.1] - 2026-02-28
+
+### Added
+- **Legacy package compatibility alias**: Added `src/pyannotate` as a compatibility shim that proxies to `annot8`.
+  - Enables legacy lint/test commands such as `pylint src/pyannotate tests`
+  - Preserves behavior through lazy proxy functions (`process_file`, `walk_directory`, `main`)
+
+- **Pytest startup hook**: Added `tests/conftest.py` to centralize test marker registration and ensure compatibility imports for coverage workflows.
+
+### Changed
+- **Development dependencies**: Added `PyYAML` to `requirements-dev.txt` so YAML template tests run by default in the dev environment.
+- **Template test maintenance**: Refactored duplicated setup logic in template tests into shared utilities (`tests/test_utils.py`), reducing duplication and keeping lint score at `10.00/10`.
+
+### Fixed
+- **Pylint fatal target mismatch**: Removed `F0001` failure when linting `src/pyannotate`.
+- **Template test skip behavior in standard dev setup**: YAML-specific tests now run instead of being skipped once dev dependencies are installed.
+
+---
+
+## [0.12.0] - 2026-02-28
+
+### Added
+
+#### Documentation
+- **Comprehensive Template System Documentation**: Added extensive "Template System" section to README.md with 15+ practical examples
+  - Complete variable reference table with all 9 template variables
+  - Examples for YAML, JSON, and TOML configuration formats
+  - Comment style adaptation examples for Python, JavaScript, CSS, HTML, SQL
+  - Git metadata integration guide
+  - Best practices and advanced scenarios (corporate, open source templates)
+  - Different templates for different projects guide
+
+- **Enhanced README**: Completely restructured Key Features section with categorized capabilities
+  - 🎯 Intelligent Header Management
+  - 🌍 Comprehensive Language Support (70+ Languages)
+  - 🛡️ Smart File Protection
+  - 🔧 Git Integration
+  - ⚙️ Flexible Configuration
+  - 🔒 Safety & Reliability
+  - 💻 Developer Experience
+  - Added Quick Start section for new users
+  - Enhanced Python API examples with all available options
+  - Expanded Protected Files & Directories section with detailed categorization
+
+- **Development Guide**: Created CLAUDE.md with comprehensive development instructions
+  - Core architecture overview
+  - Module organization details
+  - Key design patterns (header detection, special declaration preservation, idempotent operations)
+  - Development commands (testing, linting, building)
+  - Testing patterns and organization
+  - Configuration system explanation
+  - CI/CD and code style guidelines
+
+#### Testing
+- **Comprehensive Template Test Suite**: Added 38 new tests in test_templates_comprehensive.py
+  - TestTemplateVariables (9 tests): All template variables
+  - TestTemplateFallbackValues (5 tests): Fallback syntax with various scenarios
+  - TestMultiLineTemplates (3 tests): Multi-line template rendering
+  - TestTemplateCommentStyles (7 tests): Adaptation to different comment styles
+  - TestTemplateWithSpecialCases (4 tests): Shebang, XML, DOCTYPE preservation
+  - TestTemplateConfigFormats (3 tests): YAML, JSON, TOML configurations
+  - TestTemplateEdgeCases (4 tests): Edge cases and error handling
+  - TestTemplateIntegration (3 tests): Integration with other features
+
+- **Test Coverage**: Template system now has 100% test coverage
+  - 36 tests passing, 2 skipped (YAML tests when PyYAML not installed)
+  - Total project tests: 236+ tests
+
+### Fixed
+- **Code Quality**: Resolved all pylint issues (10.00/10)
+  - Fixed implicit string concatenation
+  - Moved imports to module level
+  - Fixed long lines (>100 characters)
+
+### Changed
+- Reorganized README.md structure for better user experience
+- Enhanced Python API documentation with comprehensive examples
+- Improved categorization of ignored files and directories
+
+---
+
+## [0.11.1] - Previous Release
+
+### Features
+- Enhanced CommonJS and ES Module support
+- Improved header detection and merging
+- Git integration with pre-commit hooks
+
+---
+
+[0.12.1]: https://github.com/soulwax/annot8/compare/v0.12.0...v0.12.1
+[0.12.0]: https://github.com/soulwax/annot8/compare/v0.11.1...v0.12.0
+[0.11.1]: https://github.com/soulwax/annot8/releases/tag/v0.11.1