Skip to content

Prepare package for PyPI release#2

Merged
claying merged 1 commit into
mainfrom
release-prep
May 13, 2026
Merged

Prepare package for PyPI release#2
claying merged 1 commit into
mainfrom
release-prep

Conversation

@claying
Copy link
Copy Markdown
Collaborator

@claying claying commented May 13, 2026

Summary

  • Packaging: switched to find-based package discovery so all subpackages (tedbench.*, minesm.*) are correctly installed; pinned setuptools>=64 / setuptools-scm>=8; populated dependencies from requirements.txt; moved fair-esm to a [baselines] optional extra; added py.typed (PEP 561) and richer PyPI classifiers
  • Top-level API: tedbench/__init__.py with tedbench.load_model(name), tedbench.list_models(), and __version__; model registry covers all 12 TEDBench/* HF checkpoints (S/B/B+seq/L × pretrained/fine-tuned/from-scratch)
  • CITATION.cff: machine-readable citation for GitHub's "Cite this repository" button
  • CHANGELOG.md: initial v0.1.0 entry
  • CI (.github/workflows/ci.yml): runs on every push/PR to main; installs the package with --no-deps and uses importlib.util.find_spec to verify all subpackages are discoverable without pulling in torch or other heavy deps
  • README: pip install TEDBench as recommended option, [baselines] extra documented, tedbench.load_model / tedbench.list_models usage example

To publish after merging

  1. PyPI trusted publishing — pypi.org → Account → Publishing → Add pending publisher: project TEDBench, owner BorgwardtLab, repo TEDBench, workflow publish.yml, environment pypi
  2. GitHub environment — repo Settings → Environments → create pypi
  3. Tag the release:
    git tag v0.1.0
    git push origin v0.1.0

🤖 Generated with Claude Code

Packaging
- pyproject.toml: switch to find-based package discovery (tedbench*,
  minesm*) so all subpackages are correctly installed; pin
  setuptools>=64 / setuptools-scm>=8; populate dependencies from
  requirements.txt; move fair-esm to [baselines] optional extra;
  add py.typed to package-data; richer classifiers (Development Status,
  Intended Audience, License, OS, Python 3.9–3.11, two Topic entries)
- tedbench/py.typed: PEP 561 marker for type checkers

Top-level API
- tedbench/__init__.py: __version__ via importlib.metadata,
  list_models() returning metadata for all 12 TEDBench/* HF models,
  load_model(name) resolving short names via registry or passing
  through full HF repo IDs / local paths

Documentation
- README: pip install TEDBench as recommended option, baselines extra,
  tedbench.load_model / tedbench.list_models usage example
- CITATION.cff: machine-readable citation for GitHub's Cite button
- CHANGELOG.md: initial v0.1.0 entry

CI / CD
- .github/workflows/ci.yml: import-check CI on push/PR to main;
  uses --no-deps + find_spec to verify package structure without
  pulling in torch or other heavy runtime deps
- .github/workflows/publish.yml: publish to PyPI on v* tag push
  via OIDC trusted publishing (already committed on main)

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@claying claying merged commit 0321976 into main May 13, 2026
4 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