Skip to content

Release xrayatlas 0.1.0: CI, PyPI publishing, license, and package metadata - #2

Merged
HarlanHeilman merged 3 commits into
mainfrom
ci/pypi-release
Nov 9, 2026
Merged

HarlanHeilman merged 3 commits into
mainfrom
ci/pypi-release

Conversation

@HarlanHeilman

@HarlanHeilman HarlanHeilman commented Nov 9, 2026 •

Copy link
Copy Markdown
Member

Summary

Release candidate for xrayatlas 0.1.0. Merging this PR publishes 0.1.0 to PyPI, tags v0.1.0, and creates the GitHub release.

Changes

  • ci.yml: ruff lint, ruff format check, and mypy on src; pytest on Python 3.10 to 3.14; wheel and sdist build with twine check --strict. Runs on every PR and on main, and is reused by the release workflow.
  • release.yml, following the ALS-RSOXS refloxide and lineshapes pattern: on a push to main that touches the package, a check job releases only when v<pyproject version> has no tag. It then runs CI, builds and smoke-imports the wheel, publishes through PyPI Trusted Publishing (pypi environment, skip-existing), and creates the tag and GitHub release with generated notes. workflow_dispatch with dry_run builds without publishing.
  • BSD-3-Clause LICENSE (WSU Carbon Lab), declared as a PEP 639 license expression.
  • PyPI metadata: project URLs (website docs at xrayatlas.wsu.edu/docs/python), classifiers, keywords, Typing :: Typed.
  • The README is now the PyPI landing page: install, sign in, quickstart, and links to the website guides. The long API walkthrough moved to the website docs.
  • The sdist excludes .github/, .python-version, and uv.lock.

Test Plan

  • uv lock --check, ruff check, ruff format --check, mypy src, pytest (229 passed)
  • uv build plus twine check --strict on the wheel and sdist; license and URLs present in the wheel METADATA
  • Wheel installs and imports in a clean Python 3.10 venv
  • actionlint clean on both workflows
  • pypi environment exists in this repository
  • PyPI trusted publisher registered for xrayatlas (owner WSU-Carbon-Lab, repo atlas-python, workflow release.yml, environment pypi)
  • CI green on this PR

AI Role (required)

Choose one of the following and briefly justify it:

  • Level 1: Mostly suggestions, tab completion, and minimal code generation
  • Level 2: Extensive code generation, but heavily managed; business and scientific logic was dictated by the contributor
  • Level 3: Fully vibe coded; PRs using this level will likely be thrown away, but may contain nuggets a maintainer chooses to review

If you selected Level 2 or Level 3, include at least one sentence describing how you validated correctness (tests, types, manual verification, scientific sanity checks).

🤖 Generated with Claude Code

@HarlanHeilman
HarlanHeilman marked this pull request as ready for review November 9, 2026 19:17
@HarlanHeilman
HarlanHeilman merged commit 6d1bedf into main Nov 9, 2026
7 checks passed
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