Skip to content

feat: add trusted PyPI publishing workflow and package metadata#87

Open
franktore wants to merge 7 commits into
mainfrom
feature/make-ready-for-publish-on-pypi
Open

feat: add trusted PyPI publishing workflow and package metadata#87
franktore wants to merge 7 commits into
mainfrom
feature/make-ready-for-publish-on-pypi

Conversation

@franktore

@franktore franktore commented Jul 3, 2026

Copy link
Copy Markdown
Contributor

add GitHub Actions workflow for trusted publishing to TestPyPI (manual) and PyPI (tag-based) enrich package metadata (license SPDX, URLs, keywords, classifiers, package include) mark package maturity as Production/Stable
update README with PyPI install instructions and supported Python version

Description

This pull request enhances the packaging, publishing, and documentation setup for the Omnia Timeseries Python SDK. The most significant changes include the addition of a GitHub Actions workflow for automated publishing to PyPI and TestPyPI, improvements to the pyproject.toml metadata, and updated installation instructions in the README.md.

Packaging and Publishing Automation:

  • Added a new GitHub Actions workflow (.github/workflows/publish-pypi.yml) to automate building and publishing the package to PyPI and TestPyPI, supporting both tag-based and manual dispatch releases.

Project Metadata Improvements:

  • Updated pyproject.toml to include license change to MIT, added homepage, repository, documentation links, keywords, classifiers, and explicit package inclusion for omnia_timeseries.
  • Added issues and changelog URLs under [tool.poetry.urls] in pyproject.toml.

Documentation Updates:

  • Improved installation instructions in README.md to clearly show how to install from PyPI or GitHub, and specified supported Python versions.

Type of change

Please delete options that are not relevant.

  • New feature (non-breaking change which adds functionality)
  • This change requires a documentation update

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

  • Test publishing on testpypi (test.pypi.org)

Test Configuration:

  • Environment: development

Checklist:

  • I have performed a self-review of my own code
  • I have commented my code in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have made corresponding changes to the architecture
  • My changes generate no new warnings
  • New and existing unit tests pass locally with my changes

add GitHub Actions workflow for trusted publishing to TestPyPI (manual) and PyPI (tag-based)
enrich package metadata (license SPDX, URLs, keywords, classifiers, package include)
mark package maturity as Production/Stable
update README with PyPI install instructions and supported Python version
Copilot AI review requested due to automatic review settings July 3, 2026 13:52

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR improves the project’s packaging and release automation by adding a trusted publishing GitHub Actions workflow, enriching Poetry package metadata for PyPI, and updating installation documentation.

Changes:

  • Added a GitHub Actions workflow to build and publish to TestPyPI (manual dispatch) and PyPI (tag-based) using trusted publishing (OIDC).
  • Expanded pyproject.toml metadata (license SPDX, URLs, keywords, classifiers, explicit package include).
  • Updated README.md installation instructions and stated supported Python versions.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.

File Description
README.md Updates installation instructions and documents supported Python versions.
pyproject.toml Adds richer package metadata (license/URLs/keywords/classifiers) and explicit package inclusion.
.github/workflows/publish-pypi.yml Introduces CI workflow to build and publish distributions to (Test)PyPI via trusted publishing.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread .github/workflows/publish-pypi.yml Outdated
Comment thread README.md Outdated
Comment thread pyproject.toml
…tting

coerce workflow_dispatch boolean input with fromJSON in publish workflow
align README Python support note with declared version constraints
normalize classifiers indentation in pyproject.toml to spaces
@franktore franktore requested review from a team, JasonHansenEQU, hakg91, janny93, nedv98, saraeq, sharmanvarun and torgeirbm and removed request for a team July 3, 2026 14:17
add release/versioning policy to CONTRIBUTING for PyPI releases
require git tag version to match pyproject version in publish workflow
fail tag-triggered publish early when versions are inconsistent
@franktore franktore deployed to development July 6, 2026 07:56 — with GitHub Actions Active
@franktore franktore linked an issue Jul 6, 2026 that may be closed by this pull request
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.

The repository is public, can Equinor publish a package to pypi

3 participants