docopt2 1.0.0__tar.gz

docopt2-1.0.0/.gitattributes

@@ -0,0 +1 @@
+* text=auto

docopt2-1.0.0/.github/dependabot.yml

@@ -0,0 +1,31 @@
+version: 2
+updates:
+  # Python dependencies via uv: the native `uv` ecosystem updates pyproject.toml
+  # AND keeps uv.lock in sync (the older `pip` ecosystem left the lock untouched).
+  - package-ecosystem: uv
+    directory: /
+    schedule:
+      interval: weekly
+    cooldown:
+      default-days: 7
+      semver-major-days: 7
+    commit-message:
+      prefix: "chore(deps)"
+    groups:
+      # One PR/week for all minor+patch bumps; majors stay individual for review.
+      python-minor-patch:
+        patterns: ["*"]
+        update-types: ["minor", "patch"]
+
+  - package-ecosystem: github-actions
+    directory: /
+    schedule:
+      interval: weekly
+    cooldown:
+      default-days: 7
+    commit-message:
+      prefix: "ci(deps)"
+    groups:
+      actions-minor-patch:
+        patterns: ["*"]
+        update-types: ["minor", "patch"]

docopt2-1.0.0/.github/workflows/ci.yml

@@ -0,0 +1,112 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
+  cancel-in-progress: true
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest]
+        python-version: ["3.10", "3.11", "3.12", "3.13", "3.14", "3.15"]
+        include:
+          # The coverage cell enforces 100% (line + branch) and uploads to Codecov. Other
+          # cells only assert pass/fail: on < 3.14 the `sys.version_info >= (3, 11)` import
+          # branch is unreachable, so 100% is only attainable on the primary version.
+          - os: ubuntu-latest
+            python-version: "3.14"
+            coverage: true
+          - os: windows-latest
+            python-version: "3.14"
+          - os: macos-latest
+            python-version: "3.14"
+    steps:
+      - uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
+        with:
+          persist-credentials: false
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@fac544c07dec837d0ccb6301d7b5580bf5edae39 # v8.2.0
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@ece7cb06caefa5fff74198d8649806c4678c61a1 # v6.3.0
+        with:
+          python-version: ${{ matrix.python-version }}
+          allow-prereleases: true
+
+      - name: Install dependencies
+        run: uv sync
+
+      - name: Test with coverage (100% gate)
+        if: matrix.coverage
+        run: uv run pytest --cov-report=xml
+
+      - name: Test
+        if: '!matrix.coverage'
+        run: uv run pytest -o addopts=
+
+      - name: Upload coverage to Codecov
+        if: matrix.coverage
+        uses: codecov/codecov-action@fb8b3582c8e4def4969c97caa2f19720cb33a72f # v7.0.0
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          files: coverage.xml
+
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
+        with:
+          persist-credentials: false
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@fac544c07dec837d0ccb6301d7b5580bf5edae39 # v8.2.0
+
+      - name: Set up Python
+        uses: actions/setup-python@ece7cb06caefa5fff74198d8649806c4678c61a1 # v6.3.0
+        with:
+          python-version: "3.14"
+
+      - name: Install dependencies
+        run: uv sync --group typecheck
+
+      - name: Ruff check
+        run: uv run ruff check src tests
+
+      - name: Ruff format check
+        run: uv run ruff format --check src tests
+
+      - name: Type check (ty)
+        run: uv run ty check
+
+      - name: Type check (mypy --strict)
+        run: uv run mypy --strict src/docopt2 tests/typing_surface/check_typed.py
+
+      - name: Type check (mypy --strict, floor target 3.10)
+        run: uv run mypy --strict --python-version 3.10 src/docopt2
+
+      - name: Type check (pyright)
+        run: uv run pyright src/docopt2 tests/typing_surface/check_typed.py
+
+      - name: Type check (pyright, floor target 3.10)
+        run: uv run pyright --pythonversion 3.10 src/docopt2
+
+  ci-ok:
+    needs: [test, lint]
+    if: always()
+    runs-on: ubuntu-latest
+    steps:
+      - name: Verify required jobs succeeded
+        run: '[ "${{ needs.test.result }}" = "success" ] && [ "${{ needs.lint.result }}" = "success" ]'

docopt2-1.0.0/.github/workflows/codeql.yml

@@ -0,0 +1,26 @@
+name: CodeQL
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+  schedule:
+    - cron: "0 3 * * 1"
+
+permissions:
+  contents: read
+
+jobs:
+  analyze:
+    runs-on: ubuntu-latest
+    permissions:
+      security-events: write
+    steps:
+      - uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
+        with:
+          persist-credentials: false
+      - uses: github/codeql-action/init@54f647b7e1bb85c95cddabcd46b0c578ec92bc1a # v4.36.3
+        with:
+          languages: python
+      - uses: github/codeql-action/analyze@54f647b7e1bb85c95cddabcd46b0c578ec92bc1a # v4.36.3

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

@@ -0,0 +1,57 @@
+name: Docs
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+permissions:
+  contents: read
+
+concurrency:
+  group: pages
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
+        with:
+          persist-credentials: false
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@fac544c07dec837d0ccb6301d7b5580bf5edae39 # v8.2.0
+
+      - name: Set up Python
+        uses: actions/setup-python@ece7cb06caefa5fff74198d8649806c4678c61a1 # v6.3.0
+        with:
+          python-version: "3.14"
+
+      - name: Install docs dependencies
+        run: uv sync --only-group docs
+
+      - name: Build docs
+        run: uv run mkdocs build --strict
+
+      - name: Upload Pages artifact
+        if: github.ref == 'refs/heads/main'
+        uses: actions/upload-pages-artifact@fc324d3547104276b827a68afc52ff2a11cc49c9 # v5.0.0
+        with:
+          path: site
+
+  deploy:
+    if: github.ref == 'refs/heads/main'
+    needs: build
+    runs-on: ubuntu-latest
+    permissions:
+      pages: write
+      id-token: write
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@cd2ce8fcbc39b97be8ca5fce6e763baed58fa128 # v5.0.0

docopt2-1.0.0/.github/workflows/publish.yml

@@ -0,0 +1,74 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: read
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write # PyPI Trusted Publishing (OIDC) + Sigstore build provenance
+      contents: write # upload artifacts to the GitHub Release
+      attestations: write # actions/attest-build-provenance
+    steps:
+      - uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
+        with:
+          persist-credentials: false
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@fac544c07dec837d0ccb6301d7b5580bf5edae39 # v8.2.0
+        with:
+          enable-cache: false
+
+      - name: Set up Python
+        uses: actions/setup-python@ece7cb06caefa5fff74198d8649806c4678c61a1 # v6.3.0
+        with:
+          python-version: "3.15"
+          allow-prereleases: true
+
+      - name: Build wheel and sdist
+        run: uv build
+
+      - name: Attest wheel provenance
+        id: attest-wheel
+        uses: actions/attest-build-provenance@0f67c3f4856b2e3261c31976d6725780e5e4c373 # v4.1.1
+        with:
+          subject-path: dist/*.whl
+
+      - name: Attest sdist provenance
+        id: attest-sdist
+        uses: actions/attest-build-provenance@0f67c3f4856b2e3261c31976d6725780e5e4c373 # v4.1.1
+        with:
+          subject-path: dist/*.tar.gz
+
+      - name: Collect provenance (sigstore bundles + in-toto)
+        env:
+          WHEEL_BUNDLE: ${{ steps.attest-wheel.outputs.bundle-path }}
+          SDIST_BUNDLE: ${{ steps.attest-sdist.outputs.bundle-path }}
+        run: |
+          mkdir -p provenance
+          cp "$WHEEL_BUNDLE" "provenance/$(basename dist/*.whl).sigstore.json"
+          cp "$SDIST_BUNDLE" "provenance/$(basename dist/*.tar.gz).sigstore.json"
+          jq -c '.dsseEnvelope' "$WHEEL_BUNDLE" > provenance/provenance.intoto.jsonl
+          jq -c '.dsseEnvelope' "$SDIST_BUNDLE" >> provenance/provenance.intoto.jsonl
+          test -s provenance/provenance.intoto.jsonl
+
+      - name: Install syft
+        uses: anchore/sbom-action/download-syft@e22c389904149dbc22b58101806040fa8d37a610 # v0.24.0
+
+      - name: Generate SBOM (CycloneDX)
+        run: syft scan dir:dist -o "cyclonedx-json=provenance/docopt2.sbom.cdx.json"
+
+      - name: Publish to PyPI (Trusted Publishing + PEP 740 attestations)
+        uses: pypa/gh-action-pypi-publish@cef221092ed1bacb1cc03d23a2d87d1d172e277b # v1.14.0
+
+      - name: Upload artifacts and provenance to the GitHub Release
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          TAG_NAME: ${{ github.event.release.tag_name }}
+        run: gh release upload "$TAG_NAME" dist/* provenance/*

docopt2-1.0.0/.github/workflows/scorecard.yml

@@ -0,0 +1,34 @@
+name: Scorecard
+
+on:
+  push:
+    branches: [main]
+  workflow_dispatch:
+  schedule:
+    - cron: "30 1 * * 6"
+
+permissions: read-all
+
+jobs:
+  analysis:
+    runs-on: ubuntu-latest
+    permissions:
+      security-events: write
+      id-token: write
+    steps:
+      - uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
+        with:
+          persist-credentials: false
+      - uses: ossf/scorecard-action@4eaacf0543bb3f2c246792bd56e8cdeffafb205a # v2.4.3
+        with:
+          results_file: results.sarif
+          results_format: sarif
+          publish_results: true
+      - uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
+        with:
+          name: SARIF file
+          path: results.sarif
+          retention-days: 5
+      - uses: github/codeql-action/upload-sarif@54f647b7e1bb85c95cddabcd46b0c578ec92bc1a # v4.36.3
+        with:
+          sarif_file: results.sarif

docopt2-1.0.0/.github/workflows/zizmor.yml

@@ -0,0 +1,25 @@
+name: Zizmor
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
+  cancel-in-progress: true
+
+permissions:
+  contents: read
+
+jobs:
+  zizmor:
+    runs-on: ubuntu-latest
+    permissions:
+      security-events: write
+    steps:
+      - uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
+        with:
+          persist-credentials: false
+      - uses: zizmorcore/zizmor-action@192e21d79ab29983730a13d1382995c2307fbcaa # v0.5.7

docopt2-1.0.0/.gitignore

@@ -0,0 +1,39 @@
+# Byte-compiled / optimized
+__pycache__/
+*.py[cod]
+*$py.class
+
+# Distribution / packaging
+build/
+dist/
+*.egg-info/
+*.egg
+
+# Virtual environments
+.venv/
+venv/
+
+# Test / coverage / type-checker caches
+.pytest_cache/
+.ruff_cache/
+.mypy_cache/
+.ty_cache/
+.hypothesis/
+.coverage
+.coverage.*
+coverage.xml
+htmlcov/
+
+# Docs (mkdocs build output)
+site/
+
+# uv
+# (uv.lock is committed on purpose; do not ignore it)
+
+# IDE
+.idea/
+
+# Upstream references kept locally for comparison, NOT part of this project.
+# ruff/pytest/coverage all skip gitignored paths, so no tool-level exclude is needed.
+docopt-master/
+

docopt2-1.0.0/CONTRIBUTING.md

@@ -0,0 +1,52 @@
+# Contributing
+
+Contributions of docs, tests, or code are welcome.
+
+## Workflow
+
+1. Fork the repo
+2. Clone your fork (`git clone <your_fork_url>`)
+3. Create a branch (`git checkout -b my_branch`)
+4. Install dependencies: `uv sync`
+5. Make your changes
+6. Run the [verification pipeline](#verification-pipeline) and fix any issues
+7. Commit using [Conventional Commits](#commit-style)
+8. Push your branch (`git push origin my_branch`)
+9. Open a [Pull Request](https://github.com/Solganis/docopt2/pulls)
+
+Read more about how pulls work on GitHub's [About pull requests](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests) page.
+
+## Requirements
+
+- Python 3.10+
+- [uv](https://docs.astral.sh/uv/) as the package manager
+
+## Verification pipeline
+
+Run all checks before submitting a PR. Every step must pass.
+
+```bash
+# lint
+uv run ruff check src tests
+
+# format
+uv run ruff format --check src tests
+
+# type check
+uv run ty check src/docopt2
+
+# tests with coverage (gated at 100%, line and branch)
+uv run pytest
+```
+
+CI requires 100% code coverage (line and branch); a PR that drops below it fails. It also runs
+`mypy --strict` and `pyright` on the typed surface, across Python 3.10 - 3.15.
+
+## Commit style
+
+Use [Conventional Commits](https://www.conventionalcommits.org/): `feat:`, `fix:`, `refactor:`, `test:`, `docs:`, `chore:`, etc.
+
+## Tests
+
+Write tests for every new feature or bug fix. The suite runs a differential check against the
+original docopt as an oracle, so behavior stays a compatible superset.

docopt2-1.0.0/LICENSE

@@ -0,0 +1,24 @@
+Copyright (c) 2012 Vladimir Keleshev, <vladimir@keleshev.com>
+Copyright (c) 2026 Solganis, <solganis.dev@gmail.com>
+
+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.

docopt2-1.0.0/NOTICE

@@ -0,0 +1,54 @@
+docopt2
+=======
+
+A typed, maintained successor to docopt. The usage message is the parser spec.
+
+This project is a fork of and derivative work based on the original docopt,
+and additionally ports two concrete improvements from docopt-ng. Both upstream
+projects are MIT licensed; this project retains the MIT license (see LICENSE).
+
+
+Original docopt
+---------------
+Copyright (c) 2012-2013 Vladimir Keleshev <vladimir@keleshev.com>
+Repository: https://github.com/docopt/docopt
+
+The core parsing engine (the Pattern / LeafPattern / BranchPattern class
+hierarchy, the usage-pattern grammar, option parsing, and matching semantics)
+is derived directly from the original docopt and preserves its behavior.
+
+A verbatim copy of the original docopt is vendored at
+tests/_vendor/docopt_original.py and used only as an oracle for the differential
+property tests (it is never imported by the shipped package).
+
+
+Ported from docopt-ng
+---------------------
+Repository: https://github.com/jazzband/docopt-ng
+
+The following improvements are ported from docopt-ng, with thanks to its
+contributors:
+
+  * Flag spellcheck / de-abbreviation: Levenshtein-based suggestion when a
+    user mistypes a long option.
+  * `collected` / `left` attributes on `DocoptExit`, so callers can inspect
+    what was parsed and what was left over when a usage match fails.
+
+docopt-ng contributors (roughly chronological), per its source headers:
+
+  * Copyright (c) 2012 Andrew Kassen <atkassen@ucdavis.edu>
+  * Copyright (c) 2012 jeffrimko <jeffrimko@gmail.com>
+  * Copyright (c) 2012 Andrew Sutton <met48@met48.com>
+  * Copyright (c) 2012 Nima Johari <nimajohari@gmail.com>
+  * Copyright (c) 2012-2013 Vladimir Keleshev <vladimir@keleshev.com>
+  * Copyright (c) 2014-2018 Matt Boersma <matt@sprout.org>
+  * Copyright (c) 2016 amir <ladsgroup@gmail.com>
+  * Copyright (c) 2015 Benjamin Bach <benjaoming@gmail.com>
+  * Copyright (c) 2017 Oleg Bulkin <o.bulkin@gmail.com>
+  * Copyright (c) 2018 Iain Barnett <iainspeed@gmail.com>
+  * Copyright (c) 2019 itdaniher <itdaniher@gmail.com>
+
+
+docopt2
+-------
+Copyright (c) 2026 Solganis <solganis.dev@gmail.com>