Prepare package for PyPI release#1
Closed
claying wants to merge 1 commit into
Closed
Conversation
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>
Collaborator
Author
|
Recreating as a single squashed commit. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
find-based package discovery so all subpackages (tedbench.*,minesm.*) are correctly installed; addedsetuptools>=64/setuptools-scm>=8; populateddependenciesfromrequirements.txt; movedfair-esmto an optional[baselines]extra so the core install has no Facebook Research dependencytedbench/__init__.pyexposingtedbench.load_model(name)andtedbench.list_models()with a registry of all 12 HF models (TEDBench/*);__version__viaimportlib.metadataDevelopment Status,Intended Audience,License,OS, Python 3.9–3.11, twoTopicentries)tedbench/py.typedmarker so mypy/pyright recognise the package as typedCITATION.cff: machine-readable citation for GitHub's "Cite this repository" buttonCHANGELOG.md: initial v0.1.0 entry.github/workflows/ci.yml): runs on every push/PR tomain, tests Python 3.10 and 3.11, verifies all subpackage imports succeedpip install TEDBench,pip install "TEDBench[baselines]", and the newtedbench.load_model/tedbench.list_modelsAPITo publish to PyPI after merging
TEDBench, workflowpublish.yml, environmentpypi)pypienvironment in GitHub repo Settings → Environments🤖 Generated with Claude Code