From 219f23dc0cfaef0963671a9b0d201b17fdc80cad Mon Sep 17 00:00:00 2001 From: Dominic Davis-Foster Date: Mon, 9 Aug 2021 19:49:51 +0100 Subject: [PATCH 1/9] Rebrand for formate --- README.rst | 4 ++-- contributing/__init__.py | 2 +- doc-source/_templates/base.html | 1 + doc-source/conf.py | 3 ++- doc-source/formate.png | Bin 0 -> 1667 bytes doc-source/getting-started.rst | 2 +- pyproject.toml | 12 ++++++------ repo_helper.yml | 11 +++++++---- 8 files changed, 20 insertions(+), 15 deletions(-) create mode 100644 doc-source/formate.png diff --git a/README.rst b/README.rst index 065ba60..9d1d43f 100644 --- a/README.rst +++ b/README.rst @@ -4,8 +4,8 @@ Contributing Guide .. start short_desc -**Contributing guide for repo-helper and associated projects** +**Contributing guide for projects in the python-formate organization** .. end short_desc -View online at https://contributing.repo-helper.uk +View online at https://contributing-to-formate.readthedocs.io/ diff --git a/contributing/__init__.py b/contributing/__init__.py index 50b7374..73c78c4 100644 --- a/contributing/__init__.py +++ b/contributing/__init__.py @@ -2,7 +2,7 @@ # # __init__.py """ -Contributing guide for repo-helper and associated projects. +Contributing guide for projects in the python-formate organization. """ # # Copyright © 2020-2021 Dominic Davis-Foster diff --git a/doc-source/_templates/base.html b/doc-source/_templates/base.html index b101b24..ffdc5ad 100644 --- a/doc-source/_templates/base.html +++ b/doc-source/_templates/base.html @@ -2,4 +2,5 @@ {% extends "!base.html" %} {% block extrahead %} + {% endblock %} diff --git a/doc-source/conf.py b/doc-source/conf.py index 1b1e520..b30076c 100644 --- a/doc-source/conf.py +++ b/doc-source/conf.py @@ -102,4 +102,5 @@ def setup(app): nitpicky = True del version del release -html_title = "repo-helper Contributing Guide" +html_title = "formate Contributing Guide" +html_logo = "formate.png" diff --git a/doc-source/formate.png b/doc-source/formate.png new file mode 100644 index 0000000000000000000000000000000000000000..02d7f8d327e9147e19344ba68596a85a286c0550 GIT binary patch literal 1667 zcmV-}27LL6P)n4`v3p{8FWQhbW?9;ba!ELWdL_~cP?peYja~^aAhuUa%Y?FJQ@H11`tU^ zK~#90?VWpw6;&9(e|L4;+*Mm;6Wz_Qw6J%iRs zV$VOU{>kV`C1OQVnNdW=TC}~au&nj5ly2Itdi&!$!?}CAGdr_8ch20I?+3%VJNKM> zzB%8_Ip6u_oNqx<6h%=KMNt$*QIvEr4|oCi9ykc>2X+GMf$0wA$~@zNZ9uW)_#61A z_ zAFjS=`QRF)K@S3xL*$=l^8X98RZ*_o@D|dbk47l7-ITevDiY<0;mAN+1TKqEZiOlH zUNwZu6BDr(P87>#rYWv8gFvVG?ig^p6Df1Ra%6H<^f@|!+0LYkk%DUh0%$<2oJ$eY^cXVeZUa82hHZaE z3B?>>L)p1D;AvoL^5W!=yRj|`kMoc*AQSyRq-Q3aTT}s#Q3W_g72p_EfMZkvj!^|T zMit-~Re)nu0gh1xI7SuV7*&8{Q~{1r1vo|(;22eaV}`jFAb=)hW8T{(=Y|8LfUU@K zMnxGKX`8EDgvtm@?DN}RYi24a4gKmMoL+V^?JSr%)q+Mn}J)g!JXbP z=i7h_k`gvcoQVxpwyfm*E!fD2UR<~X^mj>b!4B4sBVi7n09q1|yXF~*?0P?fgsNG= z|NHz_U={Ew;+8&yxT#-3+|#Aw*9f2;c`~}qXN@0GfjVFb(xAP-V}vs~!_o#kkGw1B zL?SCHhD(4?knZCh;H)avH3Rs#q^?|hOi#hymEQtaCsc0%dD`}1pSI?N>K-(6kV()$ zfl!B;e2egpa@dIU#RriAw4LZN;o_hP8E+0F0l+JbH$hAU?f{+xHY1kVT4Wv)d+h2C z)5#448euQ&>-@OC}?3iz2eJVpec=Mj%g3FaA+meqrFYio{SA zFb((+8%*{5IE9OeE0EaKMc_@~vn#RSC};>q1uFtwvVdd2B+i?RWfdq5^OaqJU$>G$S9Z0#+e5c&*vrW04gW zeaPGbU@ms@cTtGn@M72fh#gy&0l)ejTZ4XVunHK7_;G5LDJ7pbBiFSqWZ6b!a4&7Q zF~HeA$LT>o7RMl5%QRsBQ^&LjXzq_%VcK3vx~3Dko0|}eB`g=4^y{bGrSn Date: Fri, 7 Feb 2025 10:58:16 +0000 Subject: [PATCH 2/9] Updated files with 'repo_helper'. (#23) Co-authored-by: repo-helper[bot] <74742576+repo-helper[bot]@users.noreply.github.com> --- .pre-commit-config.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 216e579..94b6103 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -81,7 +81,7 @@ repos: - id: snippet-fmt - repo: https://github.com/python-formate/formate - rev: v0.7.0 + rev: v0.8.0 hooks: - id: formate exclude: ^(doc-source/conf|__pkginfo__|setup)\.(_)?py$ From 3907c5b9eebf2b131464a56f5b337429b51816d1 Mon Sep 17 00:00:00 2001 From: "repo-helper[bot]" <74742576+repo-helper[bot]@users.noreply.github.com> Date: Wed, 9 Apr 2025 11:42:53 +0100 Subject: [PATCH 3/9] Bump Ubuntu to 22.04 (#24) * Updated files with 'repo_helper'. * Updated files with 'repo_helper'. --------- Co-authored-by: repo-helper[bot] <74742576+repo-helper[bot]@users.noreply.github.com> --- .github/workflows/flake8.yml | 2 +- .github/workflows/mypy.yml | 2 +- .github/workflows/python_ci_linux.yml | 4 ++-- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/workflows/flake8.yml b/.github/workflows/flake8.yml index 0a8c0c3..af1b394 100644 --- a/.github/workflows/flake8.yml +++ b/.github/workflows/flake8.yml @@ -16,7 +16,7 @@ permissions: jobs: Run: name: "Flake8" - runs-on: "ubuntu-20.04" + runs-on: "ubuntu-22.04" steps: - name: Checkout 🛎️ diff --git a/.github/workflows/mypy.yml b/.github/workflows/mypy.yml index 10c6f30..bd74787 100644 --- a/.github/workflows/mypy.yml +++ b/.github/workflows/mypy.yml @@ -20,7 +20,7 @@ jobs: strategy: matrix: - os: ['ubuntu-20.04', 'windows-2019'] + os: ['ubuntu-22.04', 'windows-2019'] fail-fast: false steps: diff --git a/.github/workflows/python_ci_linux.yml b/.github/workflows/python_ci_linux.yml index c020c1b..ba410b3 100644 --- a/.github/workflows/python_ci_linux.yml +++ b/.github/workflows/python_ci_linux.yml @@ -19,8 +19,8 @@ permissions: jobs: tests: - name: "ubuntu-20.04 / Python ${{ matrix.config.python-version }}" - runs-on: "ubuntu-20.04" + name: "ubuntu-22.04 / Python ${{ matrix.config.python-version }}" + runs-on: "ubuntu-22.04" continue-on-error: ${{ matrix.config.experimental }} env: USING_COVERAGE: '3.8' From 4e9b0877bd53253e1c5359721d98ef98e4d2b4b5 Mon Sep 17 00:00:00 2001 From: "repo-helper[bot]" <74742576+repo-helper[bot]@users.noreply.github.com> Date: Thu, 17 Apr 2025 15:27:39 +0100 Subject: [PATCH 4/9] Updated files with 'repo_helper'. (#25) Co-authored-by: repo-helper[bot] <74742576+repo-helper[bot]@users.noreply.github.com> --- .github/workflows/python_ci_macos.yml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/workflows/python_ci_macos.yml b/.github/workflows/python_ci_macos.yml index 77f4c3b..b5f611c 100644 --- a/.github/workflows/python_ci_macos.yml +++ b/.github/workflows/python_ci_macos.yml @@ -18,8 +18,8 @@ permissions: jobs: tests: - name: "macos-13 / Python ${{ matrix.config.python-version }}" - runs-on: "macos-13" + name: "macos-${{ matrix.config.os-ver }} / Python ${{ matrix.config.python-version }}" + runs-on: "macos-${{ matrix.config.os-ver }}" continue-on-error: ${{ matrix.config.experimental }} env: USING_COVERAGE: '3.8' @@ -28,7 +28,7 @@ jobs: fail-fast: False matrix: config: - - {python-version: "3.8", testenvs: "py38,build", experimental: False} + - {python-version: "3.8", os-ver: "14", testenvs: "py38,build", experimental: False} steps: - name: Checkout 🛎️ From cf6e4a3cb5e55b227b5781c612737db128b56c23 Mon Sep 17 00:00:00 2001 From: "repo-helper[bot]" <74742576+repo-helper[bot]@users.noreply.github.com> Date: Thu, 17 Apr 2025 16:51:34 +0100 Subject: [PATCH 5/9] Bump Ubuntu to 22.04 for readthedocs (#26) Co-authored-by: repo-helper[bot] <74742576+repo-helper[bot]@users.noreply.github.com> --- .readthedocs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.readthedocs.yml b/.readthedocs.yml index e928b70..83fc025 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -13,7 +13,7 @@ python: - requirements: requirements.txt - requirements: doc-source/requirements.txt build: - os: ubuntu-20.04 + os: ubuntu-22.04 tools: python: '3.9' jobs: From 3c5ef68550de6e659182b0e45a81fdaf712b6b81 Mon Sep 17 00:00:00 2001 From: "repo-helper[bot]" <74742576+repo-helper[bot]@users.noreply.github.com> Date: Thu, 15 May 2025 11:29:35 +0100 Subject: [PATCH 6/9] Updated files with 'repo_helper'. (#27) Co-authored-by: repo-helper[bot] <74742576+repo-helper[bot]@users.noreply.github.com> --- .pre-commit-config.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 94b6103..3df0134 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -8,7 +8,7 @@ ci: repos: - repo: https://github.com/repo-helper/pyproject-parser - rev: v0.11.1 + rev: v0.13.0 hooks: - id: reformat-pyproject From 763b30669b7d02cb5529708c06bcec73824bb32a Mon Sep 17 00:00:00 2001 From: "repo-helper[bot]" <74742576+repo-helper[bot]@users.noreply.github.com> Date: Mon, 2 Jun 2025 15:15:28 +0100 Subject: [PATCH 7/9] [repo-helper] Configuration Update (#28) * Updated files with 'repo_helper'. * Updated files with 'repo_helper'. --------- Co-authored-by: repo-helper[bot] <74742576+repo-helper[bot]@users.noreply.github.com> --- tox.ini | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tox.ini b/tox.ini index a08cdc4..05fdd0a 100644 --- a/tox.ini +++ b/tox.ini @@ -98,7 +98,7 @@ deps = git+https://github.com/domdfcoding/flake8-rst-docstrings.git git+https://github.com/python-formate/flake8-unused-arguments.git@magic-methods git+https://github.com/python-formate/flake8-missing-annotations.git - pydocstyle>=6.0.0 + git+https://github.com/domdfcoding/pydocstyle.git@stub-functions pygments>=2.7.1 importlib_metadata<4.5.0; python_version<'3.8' commands = python3 -m flake8_rst_docstrings_sphinx contributing --allow-toolbox {posargs} From 687f961ec21ef1852b022d93f7a5ee09673eccfb Mon Sep 17 00:00:00 2001 From: "repo-helper[bot]" <74742576+repo-helper[bot]@users.noreply.github.com> Date: Sat, 6 Dec 2025 20:47:57 +0000 Subject: [PATCH 8/9] Updated files with 'repo_helper'. (#29) Co-authored-by: repo-helper[bot] <74742576+repo-helper[bot]@users.noreply.github.com> --- .github/workflows/docs_test_action.yml | 2 +- .github/workflows/flake8.yml | 2 +- .github/workflows/mypy.yml | 4 ++-- .github/workflows/python_ci.yml | 4 ++-- .pre-commit-config.yaml | 4 ++-- doc-source/requirements.txt | 2 ++ pyproject.toml | 2 +- tox.ini | 13 +++++++------ 8 files changed, 18 insertions(+), 15 deletions(-) diff --git a/.github/workflows/docs_test_action.yml b/.github/workflows/docs_test_action.yml index fa1b3a4..ccbfda3 100644 --- a/.github/workflows/docs_test_action.yml +++ b/.github/workflows/docs_test_action.yml @@ -20,7 +20,7 @@ jobs: uses: "actions/checkout@v4" - name: Install and Build 🔧 - uses: sphinx-toolbox/sphinx-action@sphinx-3.3.1 + uses: sphinx-toolbox/sphinx-action@sphinx-3.3.1-py39 with: pre-build-command: python -m pip install tox diff --git a/.github/workflows/flake8.yml b/.github/workflows/flake8.yml index af1b394..5e67c5c 100644 --- a/.github/workflows/flake8.yml +++ b/.github/workflows/flake8.yml @@ -35,7 +35,7 @@ jobs: if: steps.changes.outputs.code == 'true' uses: "actions/setup-python@v5" with: - python-version: "3.8" + python-version: "3.9" - name: Install dependencies 🔧 if: steps.changes.outputs.code == 'true' diff --git a/.github/workflows/mypy.yml b/.github/workflows/mypy.yml index bd74787..4c22a52 100644 --- a/.github/workflows/mypy.yml +++ b/.github/workflows/mypy.yml @@ -20,7 +20,7 @@ jobs: strategy: matrix: - os: ['ubuntu-22.04', 'windows-2019'] + os: ['ubuntu-22.04', 'windows-2022'] fail-fast: false steps: @@ -40,7 +40,7 @@ jobs: if: steps.changes.outputs.code == 'true' uses: "actions/setup-python@v5" with: - python-version: "3.8" + python-version: "3.9" - name: Install dependencies 🔧 run: | diff --git a/.github/workflows/python_ci.yml b/.github/workflows/python_ci.yml index 402027b..8bce8fa 100644 --- a/.github/workflows/python_ci.yml +++ b/.github/workflows/python_ci.yml @@ -18,8 +18,8 @@ permissions: jobs: tests: - name: "windows-2019 / Python ${{ matrix.config.python-version }}" - runs-on: "windows-2019" + name: "windows-2022 / Python ${{ matrix.config.python-version }}" + runs-on: "windows-2022" continue-on-error: ${{ matrix.config.experimental }} env: USING_COVERAGE: '3.8' diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 3df0134..99458c4 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -62,11 +62,11 @@ repos: - id: rst-inline-touching-normal - repo: https://github.com/asottile/pyupgrade - rev: v2.12.0 + rev: v3.3.0 hooks: - id: pyupgrade args: - - --py36-plus + - --py38-plus - --keep-runtime-typing - repo: https://github.com/Lucas-C/pre-commit-hooks diff --git a/doc-source/requirements.txt b/doc-source/requirements.txt index 59fd245..f625fff 100644 --- a/doc-source/requirements.txt +++ b/doc-source/requirements.txt @@ -1,7 +1,9 @@ default-values>=0.6.0 +docutils<0.22 extras-require>=0.5.0 furo==2021.06.18b36 html-section>=0.3.0 +roman>=4.0 seed-intersphinx-mapping>=1.2.2 sphinx>=3.0.3 sphinx-copybutton>=0.2.12 diff --git a/pyproject.toml b/pyproject.toml index 6510363..0eaa546 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -111,7 +111,7 @@ autodoc_exclude_members = [ ] [tool.mypy] -python_version = "3.8" +python_version = "3.9" namespace_packages = true check_untyped_defs = true warn_unused_ignores = true diff --git a/tox.ini b/tox.ini index 05fdd0a..6f0a402 100644 --- a/tox.ini +++ b/tox.ini @@ -50,7 +50,7 @@ setenv = [testenv:docs] setenv = SHOW_TODOS = 1 passenv = SPHINX_BUILDER -basepython = python3.8 +basepython = python3.9 changedir = {toxinidir}/doc-source deps = -r{toxinidir}/doc-source/requirements.txt commands = sphinx-build -M {env:SPHINX_BUILDER:html} . ./build {posargs} @@ -74,7 +74,7 @@ commands = check-wheel-contents dist/ [testenv:lint] -basepython = python3.8 +basepython = python3.9 changedir = {toxinidir} ignore_errors = True skip_install = True @@ -94,6 +94,7 @@ deps = flake8-sphinx-links>=0.0.4 flake8-strftime>=0.1.1 flake8-typing-imports>=1.10.0 + git+https://github.com/domdfcoding/restructuredtext-lint.git@fix-deprecations git+https://github.com/domdfcoding/flake8-rst-docstrings-sphinx.git git+https://github.com/domdfcoding/flake8-rst-docstrings.git git+https://github.com/python-formate/flake8-unused-arguments.git@magic-methods @@ -104,7 +105,7 @@ deps = commands = python3 -m flake8_rst_docstrings_sphinx contributing --allow-toolbox {posargs} [testenv:perflint] -basepython = python3.8 +basepython = python3.9 changedir = {toxinidir} ignore_errors = True skip_install = True @@ -112,14 +113,14 @@ deps = perflint commands = python3 -m perflint contributing {posargs} [testenv:mypy] -basepython = python3.8 +basepython = python3.9 ignore_errors = True changedir = {toxinidir} -deps = mypy==0.971 +deps = mypy==1.17.1 commands = mypy contributing {posargs} [testenv:pyup] -basepython = python3.8 +basepython = python3.9 skip_install = True ignore_errors = True changedir = {toxinidir} From d0b46ee498320bd76d9eb904fb8c86f69812e4f7 Mon Sep 17 00:00:00 2001 From: "repo-helper[bot]" <74742576+repo-helper[bot]@users.noreply.github.com> Date: Tue, 9 Dec 2025 16:18:16 +0000 Subject: [PATCH 9/9] Updated files with 'repo_helper'. --- .pre-commit-config.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 99458c4..6b33129 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -43,7 +43,7 @@ repos: - id: bind-requirements - repo: https://github.com/python-formate/flake8-dunder-all - rev: v0.4.1 + rev: v0.5.0 hooks: - id: ensure-dunder-all files: ^contributing/.*\.py$