Skip to content

chore: prepare packaging for PyPI release - #61

Merged
FranekGit merged 5 commits into
developfrom
chore/pypi-release-prep
Oct 27, 2026
Merged

FranekGit merged 5 commits into
developfrom
chore/pypi-release-prep

Conversation

@FranekGit

Copy link
Copy Markdown
Owner

Prepares the package for publishing to PyPI with the 2.0 release.

Changes

  • License: MIT (was proprietary)
  • pyproject.toml:
    • license, license-files, authors, project URLs, keywords and classifiers (Python 3.10–3.14, Typing :: Typed)
    • Version is read from src/pse_sdk/__init__.py only
    • Minimum versions for dev dependencies (pytest>=8, responses>=0.25, ruff>=0.15)
  • README: the logo and docs links use absolute GitHub URLs on main, since relative links break on PyPI
  • .github/workflows/tests.yml:
    • ruff check, ruff format check, gen_docs.py --check
    • pytest on Python 3.10–3.14
    • pytest on Python 3.10 with the oldest dependency versions allowed (--resolution lowest-direct). numpy is held below 2 because pandas 1.5 breaks against numpy 2.
  • .github/workflows/publish.yml: Trusted Publishing, no API tokens
    • Pushing a v* tag builds and publishes to PyPI (pypi environment). The build fails if the tag doesn't match the package version.
    • Running it manually publishes to TestPyPI (testpypi environment)
  • CHANGELOG: notes the PyPI release and the license change

Notes

  • tests/manual_test.py calls the live API when it is imported. CI skips it with --ignore.
  • README links point to main, so docs/usage.md returns a 404 until the release is merged there.

Testing

  • uv build and twine check pass. The wheel contains only pse_sdk/ and LICENSE.md.
  • pytest passes (688) on Python 3.13, 3.14 and on 3.10 with the oldest dependency versions

@FranekGit
FranekGit merged commit b03ab01 into develop Oct 27, 2026
7 checks passed
@FranekGit
FranekGit deleted the chore/pypi-release-prep branch October 27, 2026 19:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant