Skip to content

Commit

Permalink
Use poetry instead of setuptools/requirements
Browse files Browse the repository at this point in the history
  • Loading branch information
LeMyst committed Jan 6, 2024
1 parent b43d353 commit 09b3aa0
Show file tree
Hide file tree
Showing 13 changed files with 3,232 additions and 185 deletions.
2 changes: 1 addition & 1 deletion .github/dependabot.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
version: 2
updates:

updates:
# Maintain dependencies for pip
- package-ecosystem: "pip"
directory: "/"
Expand Down
134 changes: 111 additions & 23 deletions .github/workflows/publish-to-pypi.yaml
Original file line number Diff line number Diff line change
@@ -1,46 +1,134 @@
name: Publish Python 🐍 distributions 📦 to PyPI and TestPyPI
name: Publish Python 🐍 distributions 📦 to PyPI, TestPyPI and GitHub Release

on:
release:
types: [ published ]
workflow_dispatch:
push:
branches: [ master ]
pull_request:
branches: [ '**' ]

jobs:
build-n-publish:
name: Build and publish Python 🐍 distributions 📦 to PyPI and TestPyPI
build:
name: Build Python 🐍 distributions 📦
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v4.1.1

- name: Install poetry
run: pipx install poetry

- name: Set up Python 3.12
uses: actions/setup-python@v5.0.0
with:
python-version: '3.12'
cache: 'poetry'

- name: Install pypa/build
run: >-
python -m
pip install
build
--user
# Need to install poetry again in the new python version
- name: Install poetry
run: python -m pip install poetry

- name: Build a binary wheel and a source tarball
run: >-
python -m
poetry
build
--sdist
--wheel
.
- name: Publish distribution 📦 to Test PyPI
uses: pypa/gh-action-pypi-publish@v1.8.11
- name: Store the distribution packages
uses: actions/upload-artifact@v3
with:
name: python-package-distributions
path: dist/

publish-to-testpypi:
name: Publish Python 🐍 distribution 📦 to TestPyPI
if: startsWith(github.ref, 'refs/tags/') # only publish to PyPI on tag pushes
needs:
- build
runs-on: ubuntu-latest

environment:
name: testpypi
url: https://test.pypi.org/p/wikibaseintegrator

permissions:
id-token: write # IMPORTANT: mandatory for trusted publishing

steps:
- name: Download all the dists
uses: actions/download-artifact@v3
with:
name: python-package-distributions
path: dist/
- name: Publish distribution 📦 to TestPyPI
uses: pypa/gh-action-pypi-publish@release/v1
with:
user: __token__
password: ${{ secrets.test_pypi_password }}
repository_url: https://test.pypi.org/legacy/
repository-url: https://test.pypi.org/legacy/

publish-to-pypi:
name: Publish Python 🐍 distribution 📦 to PyPI
if: startsWith(github.ref, 'refs/tags/') # only publish to PyPI on tag pushes
needs:
- build
- publish-to-testpypi
runs-on: ubuntu-latest

environment:
name: pypi
url: https://pypi.org/p/wikibaseintegrator

permissions:
id-token: write # IMPORTANT: mandatory for trusted publishing

steps:
- name: Download all the dists
uses: actions/download-artifact@v3
with:
name: python-package-distributions
path: dist/
- name: Publish distribution 📦 to PyPI
if: startsWith(github.ref, 'refs/tags')
uses: pypa/gh-action-pypi-publish@v1.8.11
uses: pypa/gh-action-pypi-publish@release/v1

github-release:
name: >-
Sign the Python 🐍 distribution 📦 with Sigstore
and upload them to GitHub Release
if: startsWith(github.ref, 'refs/tags/') # only publish to PyPI on tag pushes
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@v3
with:
user: __token__
password: ${{ secrets.pypi_password }}
name: python-package-distributions
path: dist/
- name: Sign the dists with Sigstore
uses: sigstore/gh-action-sigstore-python@v1.2.3
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 }}'
31 changes: 13 additions & 18 deletions .github/workflows/python-lint.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -19,44 +19,39 @@ jobs:
steps:
- uses: actions/checkout@v4.1.1

- name: Install poetry
run: pipx install poetry

- name: Set up Python 3.12
uses: actions/setup-python@v5.0.0
with:
python-version: '3.12'
cache: 'poetry'

- name: Cache pip
uses: actions/cache@v3
with:
path: ~/.cache/pip
key: ${{ runner.os }}-pip-${{ hashFiles('requirements.txt') }}
restore-keys: |
${{ runner.os }}-pip-
${{ runner.os }}-
- name: Upgrade setup tools
run: |
python -m pip install --upgrade pip setuptools
# Need to install poetry again in the new python version
- name: Install poetry
run: python -m pip install poetry

- name: Install dependencies
run: |
python -m pip install .[dev]
python -m poetry install --with dev
- name: isort imports check
run: |
python -m isort --check --diff wikibaseintegrator test
python -m poetry run isort --check --diff wikibaseintegrator test
- name: mypy typing check
run: |
python -m mypy --install-types --non-interactive
python -m poetry run mypy --install-types --non-interactive
- name: pylint code linting
run: |
python -m pylint wikibaseintegrator test || pylint-exit $?
python -m poetry run pylint wikibaseintegrator test || python -m poetry run pylint-exit $?
- name: codespell spell checking
run: |
codespell wikibaseintegrator test
python -m poetry run codespell wikibaseintegrator test
- name: flynt string formatter converting
run: |
python -m flynt -f wikibaseintegrator test
python -m poetry run flynt -f wikibaseintegrator test
29 changes: 9 additions & 20 deletions .github/workflows/python-pytest.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,18 +7,12 @@ on:
paths:
- 'wikibaseintegrator/**.py'
- 'test/**.py'
- 'setup.cfg'
- 'setup.py'
- 'requirements.txt'
- 'pyproject.toml'
pull_request:
branches: [ '**' ]
paths:
- 'wikibaseintegrator/**.py'
- 'test/**.py'
- 'setup.cfg'
- 'setup.py'
- 'requirements.txt'
- 'pyproject.toml'

jobs:
Expand All @@ -33,28 +27,23 @@ jobs:
steps:
- uses: actions/checkout@v4.1.1

- name: Install poetry
run: pipx install poetry

- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v5.0.0
with:
python-version: ${{ matrix.python-version }}
cache: 'poetry'

- name: Cache pip
uses: actions/cache@v3
with:
path: ~/.cache/pip
key: ${{ runner.os }}-pip-${{ hashFiles('requirements.txt') }}
restore-keys: |
${{ runner.os }}-pip-
${{ runner.os }}-
- name: Upgrade setup tools
run: |
python -m pip install --upgrade pip setuptools
# Need to install poetry again in the new python version
- name: Install poetry
run: python -m pip install poetry

- name: Install dependencies
run: |
python -m pip install .[dev]
python -m poetry install --with dev
- name: Test with pytest
run: |
python -m pytest
python -m poetry run pytest
22 changes: 15 additions & 7 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,18 @@ formats:
- pdf

# Optionally set the version of Python and requirements required to build your docs
python:
version: "3.8"
install:
- method: pip
path: .
extra_requirements:
- docs
build:
os: "ubuntu-22.04"
tools:
python: "3.12"
jobs:
post_create_environment:
# Install poetry
# https://python-poetry.org/docs/#installing-manually
- python -m pip install poetry
# Tell poetry to not use a virtual environment
- python -m poetry config virtualenvs.create false
post_install:
# Install dependencies with 'docs' dependency group
# https://python-poetry.org/docs/managing-dependencies/#dependency-groups
- python -m poetry install --with docs
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -291,6 +291,14 @@ python -m pip install --upgrade pip setuptools
python -m pip install .
```

You can also use Poetry:

```bash
python -m pip install --upgrade poetry

python -m poetry install
```

To check that the installation is correct, launch a Python console and run the following code (which will retrieve the
Wikidata element for [Human](https://www.wikidata.org/entity/Q5)):

Expand Down
6 changes: 0 additions & 6 deletions docs/requirements.txt

This file was deleted.

0 comments on commit 09b3aa0

Please sign in to comment.