From 5ff963b79b1d3093768f6cd84cfea25a7e2bb58c Mon Sep 17 00:00:00 2001 From: krassowski <5832902+krassowski@users.noreply.github.com> Date: Mon, 24 Mar 2025 11:39:22 +0000 Subject: [PATCH 1/6] Drop Python 3.7 from testing, add 3.12, update action versions --- .github/workflows/publish.yml | 4 ++-- .github/workflows/tests.yml | 6 +++--- README.md | 2 +- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml index 7eb7355..5ed25a3 100644 --- a/.github/workflows/publish.yml +++ b/.github/workflows/publish.yml @@ -8,9 +8,9 @@ jobs: deploy: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@v4 - name: Set up Python 3.8 - uses: actions/setup-python@v2 + uses: actions/setup-python@v5 with: python-version: 3.8 - name: Install build dependencies diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml index 425eeff..0b55022 100644 --- a/.github/workflows/tests.yml +++ b/.github/workflows/tests.yml @@ -11,12 +11,12 @@ jobs: strategy: matrix: os: [ubuntu-latest] - python-version: [3.7, 3.8, 3.9, '3.10', '3.11'] + python-version: [3.8, 3.9, '3.10', '3.11', '3.12'] runs-on: ${{ matrix.os }} steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@v4 - name: Set up Python ${{ matrix.python-version }} - uses: actions/setup-python@v2 + uses: actions/setup-python@v5 with: python-version: ${{ matrix.python-version }} - name: Install test dependencies diff --git a/README.md b/README.md index 7d7f45f..dcd273a 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ On the fly conversion of Python docstrings to markdown -- Python 3.6+ (tested on 3.7 up to 3.11) +- Python 3.6+ (tested on 3.8 up to 3.12) - can recognise reStructuredText and convert multiple of its features to Markdown - since v0.13 includes initial support for Google-formatted docstrings From c688487e15ae0c8b4a0a7b7bfd915f5509f91ce2 Mon Sep 17 00:00:00 2001 From: krassowski <5832902+krassowski@users.noreply.github.com> Date: Mon, 24 Mar 2025 11:41:13 +0000 Subject: [PATCH 2/6] Add Python 3.13 too --- .github/workflows/tests.yml | 2 +- README.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml index 0b55022..552ea8e 100644 --- a/.github/workflows/tests.yml +++ b/.github/workflows/tests.yml @@ -11,7 +11,7 @@ jobs: strategy: matrix: os: [ubuntu-latest] - python-version: [3.8, 3.9, '3.10', '3.11', '3.12'] + python-version: [3.8, 3.9, '3.10', '3.11', '3.12', '3.13'] runs-on: ${{ matrix.os }} steps: - uses: actions/checkout@v4 diff --git a/README.md b/README.md index dcd273a..94231e4 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ On the fly conversion of Python docstrings to markdown -- Python 3.6+ (tested on 3.8 up to 3.12) +- Python 3.6+ (tested on 3.8 up to 3.13) - can recognise reStructuredText and convert multiple of its features to Markdown - since v0.13 includes initial support for Google-formatted docstrings From 6d6a6205bbf835f5cc9a6eedf643a930050cf3e1 Mon Sep 17 00:00:00 2001 From: krassowski <5832902+krassowski@users.noreply.github.com> Date: Mon, 24 Mar 2025 11:54:31 +0000 Subject: [PATCH 3/6] Unpin flake8 --- requirements-dev.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/requirements-dev.txt b/requirements-dev.txt index 76d0c2c..d6df770 100644 --- a/requirements-dev.txt +++ b/requirements-dev.txt @@ -1,5 +1,5 @@ pytest pytest-cov pytest-flake8 -flake8<5 +flake8 mypy From 7d30f61a983698d5079810a8e8badd8fbdd9ba23 Mon Sep 17 00:00:00 2001 From: krassowski <5832902+krassowski@users.noreply.github.com> Date: Mon, 24 Mar 2025 12:08:08 +0000 Subject: [PATCH 4/6] Add `pyproject.toml` with build system spec --- pyproject.toml | 3 +++ 1 file changed, 3 insertions(+) create mode 100644 pyproject.toml diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..fed528d --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,3 @@ +[build-system] +requires = ["setuptools"] +build-backend = "setuptools.build_meta" From 8d4640e6c5988be635e873ad0f769c6b23473c6c Mon Sep 17 00:00:00 2001 From: krassowski <5832902+krassowski@users.noreply.github.com> Date: Mon, 24 Mar 2025 12:12:31 +0000 Subject: [PATCH 5/6] Switch to modern build --- .github/workflows/tests.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml index 552ea8e..7429365 100644 --- a/.github/workflows/tests.yml +++ b/.github/workflows/tests.yml @@ -21,7 +21,7 @@ jobs: python-version: ${{ matrix.python-version }} - name: Install test dependencies run: | - python -m pip install --upgrade pip wheel + python -m pip install --upgrade pip wheel build python -m pip install -r requirements-dev.txt - name: Temporary installation run: python -m pip install -e . @@ -33,7 +33,7 @@ jobs: mypy docstring_to_markdown - name: Build package run: | - python setup.py sdist bdist_wheel + python -m build - name: Install package run: python -m pip install --find-links=dist --no-index --ignore-installed docstring_to_markdown - name: Pip check From ce6d89ac81188e6ab9c8d5a88c7e7c9b7f6fc0a1 Mon Sep 17 00:00:00 2001 From: krassowski <5832902+krassowski@users.noreply.github.com> Date: Mon, 24 Mar 2025 12:16:40 +0000 Subject: [PATCH 6/6] Also update to build backend in publish workflow --- .github/workflows/publish.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml index 5ed25a3..bd46cb7 100644 --- a/.github/workflows/publish.yml +++ b/.github/workflows/publish.yml @@ -15,10 +15,10 @@ jobs: python-version: 3.8 - name: Install build dependencies run: | - python -m pip install --upgrade pip wheel + python -m pip install --upgrade pip wheel build - name: Build package run: | - python setup.py sdist bdist_wheel + python -m build - name: Publish a Python distribution to PyPI uses: pypa/gh-action-pypi-publish@v1.4.1 with: