ConfigArgParse 1.7.2.dev0__tar.gz → 1.7.5__tar.gz

configargparse-1.7.5/.coveragerc

@@ -0,0 +1,12 @@
+[run]
+source = .
+relative_files = true
+omit =
+    setup.py
+
+[report]
+skip_covered = false
+show_missing = true
+
+[html]
+show_contexts = true

configargparse-1.7.5/.editorconfig

@@ -0,0 +1,17 @@
+# https://editorconfig.org/
+
+root = true
+
+[*]
+indent_style = space
+indent_size = 4
+insert_final_newline = true
+trim_trailing_whitespace = true
+end_of_line = lf
+charset = utf-8
+
+[*.py]
+max_line_length = 88
+
+[*.yml]
+indent_size = 2

configargparse-1.7.5/.git-blame-ignore-revs

@@ -0,0 +1,7 @@
+# .git-blame-ignore-revs used to ignore SHAs from git blame
+# applied automatically in Github, use the command
+# `git config blame.ignoreRevsFile .git-blame-ignore-revs` to config git to
+# use it as well
+
+# black format
+0962f7378ceec1218e30489352df4c80533d4cb8

configargparse-1.7.5/.github/workflows/apidocs.yml

@@ -0,0 +1,38 @@
+name: apidocs
+
+on:
+  push:
+    branches: [ master ]
+    tags:
+      - '*'
+
+# Set minimal permissions by default
+permissions: {}
+
+jobs:
+  deploy:
+    runs-on: macos-latest
+    permissions:
+      contents: write
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          persist-credentials: false
+      - name: Set up Python 3.8
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.8
+
+      - name: Install requirements for documentation generation
+        run: python -m pip install --upgrade pip pydoctor
+
+      - name: Generate API documentation with pydoctor
+        run: ./apidocs.sh
+
+      - name: Push API documentation to Github Pages
+        uses: peaceiris/actions-gh-pages@4f9cc6602d3f66b9c108549d475ec49e8ef4d45e   # v4.0.0
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./apidocs
+          commit_message: "Generate API documentation"

configargparse-1.7.5/.github/workflows/test.yml

@@ -0,0 +1,181 @@
+name: unit tests
+
+on:
+  push:
+    branches: [ master ]
+    tags:
+      - '*'
+  pull_request:
+
+# Set minimal permissions by default
+permissions: {}
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: ${{ github.ref != 'refs/heads/master' }}
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          persist-credentials: false
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.13
+
+      - name: Install linters
+        run: python -m pip install --upgrade pip black zizmor pydoctor
+
+      - name: Black
+        run: black . --check
+
+      - name: Zizmor
+        run: find .github/workflows -name '*.yml' | xargs zizmor --config .github/zizmor.yml
+
+      - name: Pydoctor
+        run: pydoctor ./configargparse.py --intersphinx=https://docs.python.org/3/objects.inv --docformat=google -W
+
+  test:
+    name: ${{ matrix.os }} py${{ matrix.python-version }} ${{ matrix.use-docker && '(docker)' || '' }}
+    runs-on: ${{ matrix.os }}
+
+    strategy:
+      matrix:
+        include:
+          - name: Legacy Python on Ubuntu
+            os: ubuntu-latest
+            python-version: '3.6'
+            use-docker: true
+          - name: Legacy Python on Ubuntu
+            os: ubuntu-latest
+            python-version: '3.7'
+            use-docker: true
+          - name: Legacy Python on Ubuntu
+            os: ubuntu-latest
+            python-version: '3.8'
+            use-docker: true
+
+        os: [ubuntu-latest, windows-latest, macos-latest]
+        python-version: ['3.9','3.10','3.11','3.12','3.13']
+        use-docker: [false]
+      fail-fast: false
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          persist-credentials: false
+
+      - name: Set up Python ${{ matrix.python-version }}
+        if: ${{ !matrix.use-docker }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Run tests with Docker
+        if: ${{ matrix.use-docker }}
+        run: |
+          docker run --rm -v ${{ github.workspace }}:/app -w /app python:${{ matrix.python-version }} bash -c "
+            python -m pip install --upgrade pip setuptools wheel tox
+            python -m pip install '.[test]'
+            pytest --cov-branch --cov-context=test --cov=.
+          "
+
+      - name: Run tests
+        if: ${{ !matrix.use-docker }}
+        run: |
+          python -m pip install --upgrade pip setuptools wheel tox
+          python -m pip install '.[test]'
+          pytest --cov-branch --cov-context=test --cov=.
+
+      - name: Set artifact name
+        shell: bash
+        run: |
+          ARTIFACT_NAME="coverage-${{ runner.os }}-py-${{ matrix.python-version }}"
+          ARTIFACT_NAME="${ARTIFACT_NAME//./}"
+          echo "ARTIFACT_NAME=$ARTIFACT_NAME" >> "$GITHUB_ENV"
+
+      - name: Upload coverage artifact
+        uses: actions/upload-artifact@v4
+        with:
+          include-hidden-files: true
+          if-no-files-found: error
+          name: ${{ env.ARTIFACT_NAME }}
+          path: .coverage
+          retention-days: 1
+
+  coverage:
+    runs-on: ubuntu-latest
+    needs: test
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          persist-credentials: false
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.13
+
+      - name: Download artifacts
+        uses: actions/download-artifact@v4
+        with:
+          path: downloaded_artifacts
+
+      - name: Clean up temporary artifacts
+        uses: geekyeggo/delete-artifact@f275313e70c08f6120db482d7a6b98377786765b # v5.1.0
+        with:
+          name: coverage-*
+
+      - name: Install dependencies
+        run: pip install coverage
+
+      - name: Combine coverage.py
+        run: |
+          coverage combine $(find downloaded_artifacts/ -type f | xargs)
+          coverage xml
+          coverage html
+          coverage report --format=markdown >> $GITHUB_STEP_SUMMARY
+          cp coverage.xml htmlcov/coverage.xml
+          cp .coverage htmlcov/.coverage
+
+      - name: Upload single coverage artifact
+        uses: actions/upload-artifact@v4
+        with:
+          include-hidden-files: true
+          if-no-files-found: error
+          name: htmlcov
+          path: htmlcov
+          # Retention days for main branch is 90 days, for other branches is 1 day
+          retention-days: ${{ github.ref == 'refs/heads/master' && 90 || 1 }}
+
+  release:
+      needs: [test, coverage]
+      name: PyPI
+      runs-on: ubuntu-latest
+      environment: pypi
+      permissions:
+        id-token: write
+      steps:
+        - uses: actions/checkout@v4
+          with:
+            persist-credentials: false
+
+        - name: Set up Python 3.12
+          uses: actions/setup-python@v5
+          with:
+            python-version: 3.12
+
+        - name: Install build dependencies
+          run: |
+            python -m pip install -U setuptools wheel setuptools-scm
+
+        - name: Build
+          run: |
+            python setup.py --quiet build check sdist bdist_wheel
+            ls -alh ./dist/
+
+        - name: Publish to PyPI - on tag
+          if: startsWith(github.ref, 'refs/tags/')
+          uses: pypa/gh-action-pypi-publish@release/v1

configargparse-1.7.5/.github/zizmor.yml

@@ -0,0 +1,7 @@
+rules:
+  unpinned-uses:
+    ignore: []
+    config:
+      policies:
+        actions/*: ref-pin
+        pypa/gh-action-pypi-publish: ref-pin

configargparse-1.7.5/.gitignore

@@ -0,0 +1,52 @@
+apidocs
+
+*.py[cod]
+
+# C extensions
+*.so
+
+# Packages
+*.egg
+*.egg-info
+dist
+build
+eggs
+parts
+bin
+var
+sdist
+develop-eggs
+.installed.cfg
+lib
+lib64
+
+# Installer logs
+pip-log.txt
+
+# Unit test / coverage reports
+.coverage
+.tox
+htmlcov
+#tox.ini
+#nosetests.xml
+
+# Translations
+*.mo
+
+# Mr Developer
+.mr.developer.cfg
+.project
+.pydevproject
+
+# Complexity
+output/*.html
+output/*/index.html
+
+# Sphinx
+docs/_build
+
+# IDEs
+.idea
+.claude
+
+.eggs/

configargparse-1.7.5/CONTRIBUTING.rst

@@ -0,0 +1,61 @@
+Contributing to ConfigArgParse
+------------------------------
+
+What you can do 
+~~~~~~~~~~~~~~~
+
+If you like the project and think you could help with making it better, there are many ways you can do it:
+
+- Create an issue to report a bug or suggest a new feature
+- Triage old issues that need a refresh
+- Implement fixes for existing issues
+- Help with improving the documentation
+- Spread the word about the project to your colleagues, friends, blogs or any other channels
+- Any other things you could imagine
+
+Any contribution would be of great help and we'll highly appreciate it! 
+If you have any questions, please create a new issue.
+
+Development process
+~~~~~~~~~~~~~~~~~~~
+
+Create a fork of the git repository and checkout a new branch from master branch. 
+The branch name may start with an associated issue number so that we can easily cross-reference them. 
+For example, use ``1234-some-brach-name`` as the name of the branch working to fix issue 1234. 
+Once your changes are ready and are passing the automated tests, open a pull request.
+
+Don’t forget to sync your fork once in a while to work from the latest revision.
+
+Pre-commit checks
+~~~~~~~~~~~~~~~~~
+
+- Run unit tests: ``pytest``. 
+
+Review process 
+~~~~~~~~~~~~~~
+
+- Code changes and code added should have tests: untested code is buggy code and should
+  not be accepted by reviewers.
+- All code changes must be reviewed by at least one maintainer who is not an author 
+  of the code being added.
+- When a reviewer completes a review, they should always say what the next step(s) should be: 
+  - Ok we can merge the patch as is 
+  - Some optional changes requested
+  - Some required changes are requested
+  - An issue should be opened to tackle another problem discovered during the coding process.
+- If a substantial change is pushed after a review, a follow-up review should be done. 
+  Small changes and nit-picks do not required follow-up reviews.
+
+Release process 
+~~~~~~~~~~~~~~~
+
+The following is a high level overview and might not match the current state of things.
+
+- Edit setup.py to update the version number and create a PR with this change  (suggested branch name format: ``release-1.5.1``)
+- Once that PR is approved and merged, the *owner* should push a new tag with the same name as the version i.e. ``1.5.1`` by running `git pull; git tag 1.5.1; git push --tags`. 
+  This will trigger the PyPi release process. Monitor the process in the GitHub action UI...
+
+---
+
+owner: people with administrative rights on the repo, only they are able to push a new tag.
+maintainers: people with push rights, they can merge PR if the requirements are met.