pyscaffoldext-pre-commit-ruff 1.0.0__tar.gz

pyscaffoldext_pre_commit_ruff-1.0.0/.cirrus.yml

@@ -0,0 +1,195 @@
+# Cirrus CI configuration file using the matrix feature
+# Read more under:
+# - https://cirrus-ci.org/guide/quick-start/
+# - https://cirrus-ci.org/guide/writing-tasks/
+# THIS FILE IS SUPPOSED TO BE AN EXAMPLE. MODIFY IT ACCORDING TO YOUR NEEDS!
+
+---
+# ---- Default values to be merged into tasks ----
+
+env:
+  LC_ALL: C
+  LC_CTYPE: UTF-8
+  LANG: C
+  PIP_CACHE_DIR: ${CIRRUS_WORKING_DIR}/.cache/pip
+  PRE_COMMIT_HOME: ${CIRRUS_WORKING_DIR}/.cache/pre-commit
+  CIRRUS_ARTIFACT_URL: https://api.cirrus-ci.com/v1/artifact/build/${CIRRUS_BUILD_ID}
+  # Coveralls configuration
+  CI_NAME: cirrus-ci
+  CI_BRANCH: ${CIRRUS_BRANCH}
+  CI_PULL_REQUEST: ${CIRRUS_PR}
+  CI_BUILD_NUMBER: ${CIRRUS_BUILD_ID}
+  CI_BUILD_URL: https://cirrus-ci.com/build/${CIRRUS_BUILD_ID}
+  COVERALLS_PARALLEL: "true"
+  COVERALLS_FLAG_NAME: ${CIRRUS_TASK_NAME}
+  # TODO: You will also need to set `COVERALLS_REPO_TOKEN` to work with coveralls.
+  #       We recommend that you do that via Cirrus CI web interface via
+  #       `Environment variable overrides`.
+  # See: https://coveralls-python.readthedocs.io/en/latest/usage/index.html
+
+# ---- Templates ----
+
+.task_template: &task-template
+  debug_information_script:
+    - echo "$(which python) -- $(python -VV)"
+    - echo "$(which pip) -- $(pip -VV)"
+    - python -c 'import os, sys; print(os.name, sys.platform, getattr(sys, "abiflags", None))'
+  prepare_script:  # avoid git failing with setuptools-scm
+    - git config --global user.email "you@example.com"
+    - git config --global user.name "Your Name"
+  pip_cache:
+    folder: "${CIRRUS_WORKING_DIR}/.cache/pip"
+    fingerprint_script: echo "${CIRRUS_OS}-${CIRRUS_TASK_NAME}"
+    reupload_on_changes: true
+  pre_commit_cache:
+    folder: "${CIRRUS_WORKING_DIR}/.cache/pre-commit"
+    fingerprint_script: echo "${CIRRUS_OS}-${CIRRUS_TASK_NAME}" | cat - .pre-commit-config.yaml
+    reupload_on_changes: true
+
+.test_template: &test-template
+  # Requires pip, tox, and pipx to be installed via OS/pip
+  alias: test
+  depends_on: [build]
+  <<: *task-template
+  download_artifact_script: &download-artifact
+    - curl -L -O ${CIRRUS_ARTIFACT_URL}/build/upload/dist.tar.gz
+    - tar xzf dist.tar.gz
+    - rm dist.tar.gz
+  test_script:
+    - tox --installpkg dist/*.whl -- -rfEx --durations 10 --color yes
+  submit_coverage_script:
+    - pipx run coverage xml -o coverage.xml
+    - pipx run 'coveralls<4' --submit coverage.xml
+      # ^-- https://github.com/TheKevJames/coveralls-python/issues/434
+
+# Deep clone script for POSIX environments (required for setuptools-scm)
+.clone_script: &clone |
+  if [ -z "$CIRRUS_PR" ]; then
+    git clone --recursive --branch=$CIRRUS_BRANCH https://x-access-token:${CIRRUS_REPO_CLONE_TOKEN}@github.com/${CIRRUS_REPO_FULL_NAME}.git $CIRRUS_WORKING_DIR
+    git reset --hard $CIRRUS_CHANGE_IN_REPO
+  else
+    git clone --recursive https://x-access-token:${CIRRUS_REPO_CLONE_TOKEN}@github.com/${CIRRUS_REPO_FULL_NAME}.git $CIRRUS_WORKING_DIR
+    git fetch origin pull/$CIRRUS_PR/head:pull/$CIRRUS_PR
+    git reset --hard $CIRRUS_CHANGE_IN_REPO
+  fi
+
+# ---- CI Pipeline ----
+
+build_task:
+  name: build and check (Linux - 3.11)
+  alias: build
+  container: {image: "python:3.11-bullseye"}
+  clone_script: *clone
+  <<: *task-template
+  install_script: pip install tox pre-commit
+  check_script:
+    - pre-commit run --all-files --show-diff-on-failure --color always
+  build_script:
+    - tox -e clean,build
+    - tar czf dist.tar.gz dist
+  upload_artifacts:
+    path: dist.tar.gz
+
+linux_task:
+  matrix:
+    - name: test (Linux - 3.8)
+      container: {image: "python:3.8-bookworm"}
+    - name: test (Linux - 3.10)
+      container: {image: "python:3.10-bookworm"}
+      skip: $BRANCH !=~ "^(main|master)$"
+    - name: test (Linux - 3.12)
+      container: {image: "python:3.12-bookworm"}
+    # - name: test (Linux - 3.13)
+    #   container: {image: "python:3.13-rc-bookworm"}
+    #   allow_failures: true  # Experimental
+  install_script:
+    - python -m pip install --upgrade pip tox pipx
+  <<: *test-template
+  alias: base-test
+
+mamba_task:
+  name: test (Linux - mambaforge)
+  container: {image: "condaforge/mambaforge"}
+  install_script:  # Overwrite template
+    - mamba install -y pip pipx tox curl
+  <<: *test-template
+  depends_on: [base-test]
+
+macos_task:
+  name: test (macOS - brew)
+  macos_instance:
+    image: ghcr.io/cirruslabs/macos-runner:sonoma
+  env:
+    PATH: "/opt/homebrew/opt/python/libexec/bin:${PATH}"
+  brew_cache: {folder: "$HOME/Library/Caches/Homebrew"}
+  install_script: brew install python tox pipx
+  <<: *test-template
+  depends_on: [build, base-test]
+
+freebsd_task:
+  name: test (freebsd - 3.11)
+  freebsd_instance: {image_family: freebsd-14-0}
+  install_script:
+    - pkg remove -y python lang/python
+    - pkg install -y git python311 py311-pip py311-gdbm py311-sqlite3 py311-tox py311-tomli py311-pipx
+    - ln -s /usr/local/bin/python3.11 /usr/local/bin/python
+  <<: *test-template
+  depends_on: [build, base-test]
+
+windows_task:
+  name: test (Windows - 3.12.5)
+  windows_container:
+    image: "cirrusci/windowsservercore:2019"
+    os_version: 2019
+  env:
+    CIRRUS_SHELL: bash
+    PATH: /c/Python312:/c/Python312/Scripts:/c/tools:${PATH}
+  install_script:
+    # Activate long file paths to avoid some errors
+    - ps: New-ItemProperty -Path "HKLM:\SYSTEM\CurrentControlSet\Control\FileSystem" -Name "LongPathsEnabled" -Value 1 -PropertyType DWORD -Force
+    - choco install -y --no-progress python3 --version=3.12.5 --params "/NoLockdown"
+    - choco install -y --no-progress curl
+    - pip install --upgrade certifi
+    - python -m pip install -U pip tox pipx
+  <<: *test-template
+  depends_on: [build, base-test]
+
+finalize_task:
+  container: {image: "python:3.10-bullseye"}
+  depends_on: [test]
+  <<: *task-template
+  install_script: pip install 'coveralls<4'
+    # ^-- https://github.com/TheKevJames/coveralls-python/issues/434
+  finalize_coverage_script: coveralls --finish
+
+linkcheck_task:
+  name: linkcheck (Linux - 3.10)
+  only_if: $BRANCH =~ "^(main|master)$"
+  container: {image: "python:3.10-bullseye"}
+  depends_on: [finalize]
+  allow_failures: true
+  <<: *task-template
+  install_script: pip install tox
+  download_artifact_script: *download-artifact
+  linkcheck_script: tox --installpkg dist/*.whl -e linkcheck -- -q
+
+publish_task:
+  name: publish (Linux - 3.10)
+  container: {image: "python:3.10-bookworm"}
+  depends_on: [build, base-test, test]
+  only_if: $CIRRUS_TAG =~ 'v\d.*' && $CIRRUS_USER_PERMISSION == "admin"
+  <<: *task-template
+  env:
+    TWINE_REPOSITORY: pypi
+    TWINE_USERNAME: __token__
+    TWINE_PASSWORD: $PYPI_TOKEN
+    # TODO: You can set a `environment variable override` for PYPI_TOKEN
+    #       in Cirrus CI web interface using an encrypted variable.
+    # See:
+    # - https://pypi.org/help/#apitoken
+    # - https://cirrus-ci.org/guide/writing-tasks/#encrypted-variables
+  install_script: pip install tox
+  download_artifact_script: *download-artifact
+  publish_script:
+    - ls dist/*
+    - tox -e publish

pyscaffoldext_pre_commit_ruff-1.0.0/.coveragerc

@@ -0,0 +1,28 @@
+# .coveragerc to control coverage.py
+[run]
+branch = True
+source = pyscaffoldext.pre_commit_ruff
+# omit = bad_file.py
+
+[paths]
+source =
+    src/
+    */site-packages/
+
+[report]
+# Regexes for lines to exclude from consideration
+exclude_lines =
+    # Have to re-enable the standard pragma
+    pragma: no cover
+
+    # Don't complain about missing debug-only code:
+    def __repr__
+    if self\.debug
+
+    # Don't complain if tests don't hit defensive assertion code:
+    raise AssertionError
+    raise NotImplementedError
+
+    # Don't complain if non-runnable code isn't run:
+    if 0:
+    if __name__ == .__main__.:

pyscaffoldext_pre_commit_ruff-1.0.0/.github/workflows/publish-package.yml

@@ -0,0 +1,188 @@
+# GitHub Actions configuration **EXAMPLE**,
+# MODIFY IT ACCORDING TO YOUR NEEDS!
+# Reference: https://docs.github.com/en/actions
+
+name: Test and Publish Python 🐍 distribution 📦 to PyPI and TestPyPI
+
+on:
+  push:
+    # Avoid using all the resources/limits available by checking only
+    # relevant branches and tags. Other branches can be checked via PRs.
+    branches: [main]
+    tags: ["v[0-9]*", "[0-9]+.[0-9]+*"] # Match tags that resemble a version
+  pull_request: # Run in every PR
+  workflow_dispatch: # Allow manually triggering the workflow
+  schedule:
+    # Run roughly every 15 days at 00:00 UTC
+    # (useful to check if updates on dependencies break the package)
+    - cron: "0 0 1,16 * *"
+
+permissions:
+  contents: read
+
+concurrency:
+  group: >-
+    ${{ github.workflow }}-${{ github.ref_type }}-
+    ${{ github.event.pull_request.number || github.sha }}
+  cancel-in-progress: true
+
+jobs:
+  prepare:
+    runs-on: ubuntu-latest
+    outputs:
+      wheel-distribution: ${{ steps.wheel-distribution.outputs.path }}
+    steps:
+      - uses: actions/checkout@v4
+        with: { fetch-depth: 0 } # deep clone for setuptools-scm
+      - uses: actions/setup-python@v5
+        id: setup-python
+        with: { python-version: "3.10" }
+      - name: Run static analysis and format checkers
+        run: pipx run pre-commit run --all-files --show-diff-on-failure
+      - name: Build package distribution files 📦
+        run: >-
+          pipx run --python '${{ steps.setup-python.outputs.python-path }}'
+          tox -e clean,build
+      - name: Record the path of wheel distribution
+        id: wheel-distribution
+        run: echo "path=$(ls dist/*.whl)" >> $GITHUB_OUTPUT
+      - name: Store the distribution files for use in other stages
+        # `tests` and `publish` will use the same pre-built distributions,
+        # so we make sure to release the exact same package that was tested
+        uses: actions/upload-artifact@v4
+        with:
+          name: python-distribution-files
+          path: dist/
+          retention-days: 1
+
+  test:
+    needs: prepare
+    strategy:
+      matrix:
+        python:
+          - "3.9" # oldest Python supported by PSF
+          - "3.13" # newest Python that is stable
+        platform:
+          - ubuntu-latest
+        # - macos-latest
+        # - windows-latest
+    runs-on: ${{ matrix.platform }}
+    steps:
+      - uses: actions/checkout@v4
+      - name: Setup git user
+        run: |
+            git config --global user.name "$(git --no-pager log --format=format:'%an' -n 1)"
+            git config --global user.email "$(git --no-pager log --format=format:'%ae' -n 1)"
+      - uses: actions/setup-python@v5
+        id: setup-python
+        with:
+          python-version: ${{ matrix.python }}
+      - uses: rhysd/action-setup-vim@v1.3.5
+      - name: Retrieve pre-built distribution files
+        uses: actions/download-artifact@v4
+        with: { name: python-distribution-files, path: dist/ }
+      - name: Run tests
+        run: >-
+          pipx run --python '${{ steps.setup-python.outputs.python-path }}'
+          tox --installpkg '${{ needs.prepare.outputs.wheel-distribution }}'
+          -e '${{ matrix.python }}' -- -rFEx --durations 10 --color yes -vv # pytest args
+      - name: Generate coverage report
+        run: pipx run coverage lcov -o coverage.lcov
+      - name: Coveralls GitHub Action
+        uses: coverallsapp/github-action@v2.3.4
+        with:
+          path-to-lcov: coverage.lcov
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          flag-name: ${{ matrix.platform }} - py${{ matrix.python }}
+          parallel: true
+
+  finalize:
+    needs: test
+    runs-on: ubuntu-latest
+    steps:
+      - name: Finalize coverage report
+        uses: coverallsapp/github-action@v2.3.4
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          parallel-finished: true
+
+  publish-to-testpypi:
+    name: Publish Python 🐍 distribution 📦 to TestPyPI
+    needs: finalize
+    if: ${{ github.event_name == 'push' && contains(github.ref, 'refs/tags/') }}
+    runs-on: ubuntu-latest
+
+    environment:
+      name: testpypi
+      url: https://test.pypi.org/p/panvimwiki
+
+    permissions:
+      id-token: write # IMPORTANT: mandatory for trusted publishing
+
+    steps:
+      - name: Retrieve pre-built distribution files
+        uses: actions/download-artifact@v4
+        with: { name: python-distribution-files, path: dist/ }
+      - name: Publish distribution 📦 to TestPyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          repository-url: https://test.pypi.org/legacy/
+
+  publish-to-pypi:
+    name: >-
+      Publish Python 🐍 distribution 📦 to PyPI
+    needs: [finalize, publish-to-testpypi]
+    if: ${{ github.event_name == 'push' && contains(github.ref, 'refs/tags/') }}
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/panvimwiki # Replace <package-name> with your PyPI project name
+    permissions:
+      # contents: write
+      id-token: write # IMPORTANT: mandatory for trusted publishing
+    steps:
+      - name: Retrieve pre-built distribution files
+        uses: actions/download-artifact@v4
+        with: { name: python-distribution-files, path: dist/ }
+      - name: Publish distribution 📦 to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+  github-release:
+    name: >-
+      Sign the Python 🐍 distribution 📦 with Sigstore
+      and upload them to GitHub Release
+    needs:
+      - publish-to-pypi
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: write # IMPORTANT: mandatory for making GitHub Releases
+      id-token: write # IMPORTANT: mandatory for sigstore
+
+    steps:
+      - name: Download all the dists
+        uses: actions/download-artifact@v4
+        with: { name: python-distribution-files, path: dist/ }
+      - name: Sign the dists with Sigstore
+        uses: sigstore/gh-action-sigstore-python@v3.0.0
+        with:
+          inputs: >-
+            ./dist/*.tar.gz
+            ./dist/*.whl
+      - name: Create GitHub Release
+        env:
+          GITHUB_TOKEN: ${{ github.token }}
+        run: >-
+          gh release create
+          '${{ github.ref_name }}'
+          --repo '${{ github.repository }}'
+          --notes ""
+      - name: Upload artifact signatures to GitHub Release
+        env:
+          GITHUB_TOKEN: ${{ github.token }}
+        # Upload to GitHub Release using the `gh` CLI.
+        # `dist/` contains the built packages, and the
+        # sigstore-produced signatures and certificates.
+        run: >-
+          gh release upload
+          '${{ github.ref_name }}' dist/**
+          --repo '${{ github.repository }}'

pyscaffoldext_pre_commit_ruff-1.0.0/.gitignore

@@ -0,0 +1,54 @@
+# Temporary and binary files
+*~
+*.py[cod]
+*.so
+*.cfg
+!.isort.cfg
+!setup.cfg
+*.orig
+*.log
+*.pot
+__pycache__/*
+.cache/*
+.*.swp
+*/.ipynb_checkpoints/*
+.DS_Store
+
+# Project files
+.ropeproject
+.project
+.pydevproject
+.settings
+.idea
+.vscode
+tags
+
+# Package files
+*.egg
+*.eggs/
+.installed.cfg
+*.egg-info
+
+# Unittest and coverage
+htmlcov/*
+.coverage
+.coverage.*
+.tox
+junit*.xml
+coverage.xml
+.pytest_cache/
+
+# Build and docs folder/files
+build/*
+dist/*
+sdist/*
+docs/api/*
+docs/_rst/*
+docs/_build/*
+cover/*
+MANIFEST
+
+# Per-project virtualenvs
+.venv*/
+.conda*/
+.python-version

pyscaffoldext_pre_commit_ruff-1.0.0/.pre-commit-config.yaml

@@ -0,0 +1,45 @@
+exclude: "^docs/conf.py"
+
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: trailing-whitespace
+      - id: check-added-large-files
+      - id: check-ast
+      - id: check-json
+      - id: check-merge-conflict
+      - id: check-xml
+      - id: check-yaml
+      - id: debug-statements
+      - id: end-of-file-fixer
+      - id: requirements-txt-fixer
+      - id: mixed-line-ending
+        args: ["--fix=auto"] # replace 'auto' with 'lf' to enforce Linux/Mac line endings or 'crlf' for Windows
+
+  ## ruff-pre-commit
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    # Ruff version.
+    rev: v0.7.0
+    hooks:
+      # Run the linter.
+      - id: ruff
+        types_or: [python, pyi]
+        args: [--fix]
+      # Run the formatter.
+      - id: ruff-format
+        types_or: [python, pyi]
+
+  ## Check for misspells in documentation files:
+  - repo: https://github.com/codespell-project/codespell
+    rev: v2.3.0
+    hooks:
+      - id: codespell
+
+  ## pre-commit-rst-lint
+  - repo: https://github.com/hoefling/pre-commit-rst-lint
+    rev: "0ea7c4e56416e3d38012dfcccecd35a7d95bd1dd"
+    hooks:
+      - id: rst-lint
+        exclude: ^docs
+        additional_dependencies: [pygments]

pyscaffoldext_pre_commit_ruff-1.0.0/.readthedocs.yml

@@ -0,0 +1,27 @@
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+  configuration: docs/conf.py
+
+# Build documentation with MkDocs
+#mkdocs:
+#  configuration: mkdocs.yml
+
+# Optionally build your docs in additional formats such as PDF
+formats:
+  - pdf
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+
+python:
+  install:
+    - requirements: docs/requirements.txt
+    - {path: ., method: pip}

pyscaffoldext_pre_commit_ruff-1.0.0/AUTHORS.rst

@@ -0,0 +1,5 @@
+============
+Contributors
+============
+
+* John D. Fisher <jdfenw@gmail.com>

pyscaffoldext_pre_commit_ruff-1.0.0/CHANGELOG.rst

@@ -0,0 +1,57 @@
+Changelog
+=========
+
+All notable changes to this project will be documented in this file.
+
+The format is based on `Keep a Changelog`_, and this project adheres to
+`Semantic Versioning`_.
+
+`Unreleased`_
+-------------
+
+Added
+~~~~~
+
+Changed
+~~~~~~~
+
+Removed
+~~~~~~~
+
+`1.0.0`_ - 2024-11-21
+---------------------
+
+.. _added-1:
+
+Added
+~~~~~
+
+- Include –pre-commit by default because –pre-commit-ruff extends
+  –pre-commit.
+- Add ``ruff`` configuration to ``pyproject.toml`` because ``ruff`` does
+  not support ``setup.cfg``.
+- Extend pre-commit template with ``ruff`` lint and fix.
+- Add ``mypy`` configuration to ``setup.cfg`` and template.
+
+.. _changed-1:
+
+Changed
+~~~~~~~
+
+- Minimum ``tox`` version 4.2.23
+- Adopt ``ruff``, ``ruff-format``, ``codespell``, and ``rst-lint`` for
+  project.
+
+.. _removed-1:
+
+Removed
+~~~~~~~
+
+- ``isort`` configuration
+- ``flake8`` template and configuration
+- ``[testenv:publish]`` in ``tox.ini``
+
+.. _Keep a Changelog: https://keepachangelog.com/en/1.0.0/
+.. _Semantic Versioning: https://semver.org/spec/v2.0.0.html
+.. _Unreleased: https://github.com/jfishe/pyscaffoldext-pre-commit-ruff/compare/1.0.0...HEAD
+.. _1.0.0: https://github.com/jfishe/pyscaffoldext-pre-commit-ruff/compare/3e1993e7efea9da6d7e8007317cc6d3ea3333a65...1.0.0