pyproject-pre-commit 0.2.4__tar.gz → 0.3.0__tar.gz

pyproject_pre_commit-0.3.0/.github/FUNDING.yml

@@ -0,0 +1,3 @@
+# These are supported funding model platforms
+
+github: [rcmdnk]

pyproject_pre_commit-0.3.0/.github/workflows/pypi.yml

@@ -0,0 +1,84 @@
+---
+name: publish
+
+on:
+  schedule:
+      - cron:  '0 0 1 * *'
+  workflow_dispatch:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  check:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          ref: main
+      - name: Compare to the last tag
+        id: check
+        run: |
+          git pull --tags
+          last_tag=$(git tag --sort=version:refname | tail -n1)
+          echo $last_tag
+          if [ -n "$(git diff $last_tag src pyproject.toml)" ];then
+            echo "flag=1" >> $GITHUB_OUTPUT
+          else
+            echo "flag=0"  >> $GITHUB_OUTPUT
+          fi
+      - name: Update tag
+        id: update
+        if: ${{ steps.check.outputs.flag == 1 }}
+        run: |
+          last_tag=$(git tag --sort=version:refname | tail -n1)
+          minor=${last_tag##*.}
+          ((++minor))
+          new_tag=${last_tag%.*}.${minor}
+          new_tag_no_v=${new_tag#v}
+          sed -i"" "s/^version.*$/version = \"${new_tag_no_v}\"/" pyproject.toml
+          if [ -n "$(git diff)" ];then
+            echo "flag=1" >> $GITHUB_OUTPUT
+            echo "lat_tag=${last_tag}" >> $GITHUB_OUTPUT
+            echo "new_tag=${new_tag}" >> $GITHUB_OUTPUT
+          else
+            echo "flag=0"  >> $GITHUB_OUTPUT
+          fi
+      - name: Commit and push
+        if: ${{ steps.check.outputs.flag == 1 && steps.update.outputs.flag == 1 }}
+        run: |
+          git config --local user.email "41898282+github-actions[bot]@users.noreply.github.com"
+          git config --local user.name "github-actions[bot]"
+          git add .
+          PRE_COMMIT_ALLOW_NO_CONFIG=1 git commit -m "update tag"
+      - name: Make new tag
+        if: ${{ steps.check.outputs.flag == 1 && steps.update.outputs.flag == 1 }}
+        run: |
+          comment=$(git log --pretty='%h - %s (%an)' ${{ steps.update.outputs.last_tag }}..HEAD|cut -d'-' -f2-)
+          git tag -a ${{ steps.update.outputs.new_tag }} -m "${comment}"
+          git push --tag
+      - name: Push
+        if: ${{ steps.check.outputs.flag == 1 && steps.update.outputs.flag == 1 }}
+        uses: ad-m/github-push-action@master
+        with:
+          github_token: ${{ github.token }}
+          branch: main
+      - name: Push new tag
+        if: ${{ steps.check.outputs.flag == 1 && steps.update.outputs.flag == 1 }}
+        uses: ad-m/github-push-action@master
+        with:
+          github_token: ${{ github.token }}
+          tags: true
+      - uses: actions/setup-python@v5
+        if: ${{ steps.check.outputs.flag == 1 }}
+        with:
+          python-version: "3.10"
+      - name: Publish to PyPI
+        if: ${{ steps.check.outputs.flag == 1 }}
+        run: |
+          pip install poetry
+          poetry config pypi-token.pypi ${{ secrets.PYPI_TOKEN }}
+          poetry publish --build

pyproject_pre_commit-0.3.0/.github/workflows/test.yml

@@ -0,0 +1,100 @@
+---
+name: test
+
+on:
+  push:
+    branches-ignore:
+      - "coverage"
+      - "renovate/**"
+  pull_request:
+  workflow_dispatch:
+    inputs:
+      main_branch:
+        description: "Main branch for coverage/tmate."
+        type: string
+        required: false
+        default: "main"
+      main_os:
+        description: "Main os for coverage/tmate."
+        type: choice
+        default: "ubuntu-latest"
+        options:
+          - "ubuntu-latest"
+      main_py_ver:
+        description: "Main python version for coverage/tmate."
+        type: choice
+        default: "3.10"
+        options:
+          - "3.11"
+          - "3.10"
+          - "3.9"
+          - "3.8"
+      tmate:
+        type: boolean
+        description: 'Run the build with tmate debugging enabled (https://github.com/marketplace/actions/debugging-with-tmate). This is only for main strategy and others will be stopped.'
+        required: false
+        default: false
+
+env:
+  main_branch: ${{ inputs.main_branch || 'main' }}
+  main_os: ${{ inputs.main_os || 'ubuntu-latest' }}
+  main_py_ver: ${{ inputs.main_py_ver || '3.10' }}
+  tmate: ${{ inputs.tmate || 'false' }}
+
+
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  test_matrix:
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest]
+        python-version: ["3.12", "3.11", "3.10", "3.9", "3.8"]
+    permissions:
+      contents: write
+    runs-on: ${{ matrix.os }}
+    steps:
+      - name: Check is main
+        id: is_main
+        run: |
+          if [ "${{ github.ref }}" = "refs/heads/${{ env.MAIN_BRANCH }}" ] && [ "${{ matrix.os }}" = "${{ env.MAIN_OS }}" ] && [ "${{ matrix.python-version }}" = "${{ env.MAIN_PY_VER }}" ];then
+            echo "IS_MAIN=1" >> $GITHUB_ENV
+            is_main=1
+          else
+            echo "IS_MAIN=0" >> $GITHUB_ENV
+            is_main=0
+          fi
+          if [ "${{ env.TMATE }}" = "true" ];then
+            if [ "$is_main" = 0 ];then
+              echo "Tmate is enabled and this is not main, skip tests"
+              exit 1
+            fi
+            echo "DEBUG=1" >> $GITHUB_ENV
+          else
+            echo "DEBUG=0" >> $GITHUB_ENV
+          fi
+      - uses: rcmdnk/python-action@v2
+        with:
+          checkout: 1
+          setup-python: 1
+          python-version: "${{ matrix.python-version }}"
+          pip: 'pip'
+          setup-cmd: 'poetry install'
+          pip-packages: ''
+          poetry: 1
+          cache: 'poetry'
+          pytest: 1
+          pytest-tests-path: 'tests/'
+          pytest-ignore: ''
+          pytest-separate-benchmark: 0
+          coverage: 1
+          coverage-cov-path: 'src'
+          coverage-push: "${{ env.IS_MAIN }}"
+          coverage-push-condition: "branch=${{ env.MAIN_BRANCH }}, os=${{ env.MAIN_OS }}, python_version=${{ env.MAIN_PY_VER }}"
+          github_token: "${{github.token}}"
+          pre-commit: "${{ env.IS_MAIN }}"
+          tmate: "${{ env.DEBUG }}"

pyproject_pre_commit-0.3.0/.gitignore

@@ -0,0 +1,167 @@
+# Ref: https://github.com/github/gitignore/blob/main/Python.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/
+pip-wheel-metadata/
+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/
+pytest*
+
+# 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
+.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
+
+# 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/#use-with-ide
+.pdm.toml
+
+# 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/
+
+# Others
+.DS_Store
+/*.txt
+/*.py

pyproject_pre_commit-0.3.0/.pre-commit-config.yaml

@@ -0,0 +1,217 @@
+repos:
+  - repo: local
+    hooks:
+      - id: ruff-lint-diff
+        # https://github.com/astral-sh/ruff-pre-commit
+        name: ruff-lint-diff
+        description: "Show diff of ruff for linting"
+        entry: ruff check --diff --force-exclude
+        language: system
+        types_or:
+          - python
+          - pyi
+          - jupyter
+        require_serial: true
+        minimum_pre_commit_version: "2.9.2"
+        verbose: true
+      - id: ruff-lint
+        # https://github.com/astral-sh/ruff-pre-commit
+        name: ruff-lint
+        description: "Fix by ruff for linting"
+        entry: ruff check --fix --force-exclude
+        language: system
+        types_or:
+          - python
+          - pyi
+          - jupyter
+        require_serial: true
+        minimum_pre_commit_version: "2.9.2"
+      - id: ruff-format-diff
+        name: ruff-format-diff
+        description: "Show diff of ruff for formatting"
+        entry: ruff format --diff --force-exclude
+        language: python
+        types_or:
+          - python
+          - pyi
+          - jupyter
+        require_serial: true
+        minimum_pre_commit_version: "2.9.2"
+        verbose: true
+      - id: ruff-format
+        name: ruff-format
+        description: "Fix by ruff for formatting"
+        entry: ruff format --force-exclude
+        language: python
+        types_or:
+          - python
+          - pyi
+          - jupyter
+        require_serial: true
+        minimum_pre_commit_version: "2.9.2"
+      - id: black-diff
+        name: black-diff
+        entry: black
+        language: system
+        types_or:
+          - python
+          - pyi
+        require_serial: true
+        args:
+          - "--diff"
+          - "--color"
+          - "--quiet"
+        verbose: true
+      - id: black
+        # https://github.com/psf/black-pre-commit-mirror
+        name: black
+        entry: black
+        language: system
+        types_or:
+          - python
+          - pyi
+        require_serial: true
+        args:
+          - "--quiet"
+      - id: blacken-docs
+        # https://github.com/asottile/blacken-docs
+        name: blacken-docs
+        entry: blacken-docs
+        language: system
+        files: '\.(rst|md|markdown|py|tex)$'
+      - id: autoflake-diff
+        name: autoflake-diff
+        entry: autoflake
+        language: system
+        types:
+          - python
+        require_serial: true
+        verbose: true
+      - id: autoflake
+        # https://github.com/PyCQA/autoflake
+        name: autoflake
+        entry: autoflake
+        language: system
+        types:
+          - python
+        require_serial: true
+        args:
+          - "--in-place"
+      - id: autopep8-diff
+        name: autopep8-diff
+        entry: autopep8
+        language: system
+        types:
+          - python
+        args:
+          - "--diff"
+        verbose: true
+      - id: autopep8
+        # https://github.com/hhatto/autopep8
+        name: autopep8
+        entry: autopep8
+        language: system
+        types:
+          - python
+        args:
+          - "--in-place"
+      - id: isort-diff
+        name: isort-diff
+        entry: isort
+        language: system
+        require_serial: true
+        types_or:
+          - cython
+          - pyi
+          - python
+        args:
+          - '--diff'
+          - '--filter-files'
+        verbose: true
+      - id: isort
+        # https://github.com/PyCQA/isort
+        name: isort
+        entry: isort
+        language: system
+        require_serial: true
+        types_or:
+          - cython
+          - pyi
+          - python
+        args:
+        - '--filter-files'
+      - id: flake8
+        # https://gitlab.com/pycqa/flake8
+        name: flake8
+        entry: flake8
+        language: system
+        types:
+          - python
+        require_serial: true
+      - id: bandit
+        # https://github.com/PyCQA/bandit
+        name: bandit
+        entry: bandit
+        language: system
+        types:
+          - python
+        args:
+          - "-c"
+          - "pyproject.toml"
+      - id: mypy
+        # https://github.com/pre-commit/mirrors-mypy
+        name: mypy
+        entry: mypy
+        language: system
+        types_or:
+          - python
+          - pyi
+        require_serial: true
+        pass_filenames: false
+      - id: numpydoc-validation
+        # https://github.com/numpy/numpydoc
+        name: numpydoc-validation
+        entry: validate-docstrings
+        require_serial: true
+        language: system
+        types:
+          - python
+      - id: shellcheck
+        # https://github.com/shellcheck-py/shellcheck-py
+        name: shellcheck
+        entry: shellcheck
+        language: system
+        types: [shell]
+        require_serial: true
+      - id: mdformat-check
+        name: mdformat-check
+        entry: mdformat
+        language: system
+        types: [markdown]
+        args:
+          - "--check"
+      - id: mdformat
+        name: mdformat
+        entry: mdformat
+        language: system
+        types: [markdown]
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: check-byte-order-marker
+      - id: check-yaml
+      - id: check-json
+      - id: check-toml
+      - id: check-case-conflict
+      - id: check-merge-conflict
+        args:
+          - "--assume-in-merge"
+      - id: end-of-file-fixer
+      - id: fix-byte-order-marker
+      - id: mixed-line-ending
+      - id: trailing-whitespace
+      - id: debug-statements
+      - id: detect-private-key
+      - id: detect-aws-credentials
+        args:
+          - "--allow-missing-credentials"