Merged
Conversation
Contributor
|
Do we need any changes to the top-level README? |
diehlbw
reviewed
Jul 15, 2025
README.md
Outdated
| This package is not currently published to PyPI, but it can be installed directly from GitHub using `pip`. This is the recommended approach for programmatic use (e.g., from scripts or services): | ||
|
|
||
| ```bash | ||
| pip install git+https://github.com/epic-open-source/evaluation-instruments.git |
Contributor
There was a problem hiding this comment.
the example should probably specify ...evaluation-instruments.git@vX.Y.Z and the text should mention that pinning to a release similarly to pinning a version is recommended
Contributor
Author
There was a problem hiding this comment.
Updated. We should probably change the convention to vX.Y.Z for future tags. maybe even re-tag 0.0.1.
diehlbw
reviewed
Jul 16, 2025
Co-authored-by: diehlbw <36572844+diehlbw@users.noreply.github.com>
diehlbw
approved these changes
Jul 16, 2025
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
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.
Overview
This PR restructures the repository to ensure that all files under the
instruments/ folderare included in both the wheel (.whl) and source (.tar.gz) distributions. To achieve this, theinstruments/ directoryhas been moved intosrc/evaluation_instruments/, making it part of the package namespace and accessible at runtime. Thesetup.cfghas been updated to include the folder’s contents during wheel builds by configuring thepackage_datasection. Additionally,MANIFEST.inhas been revised to explicitly include all relevant file types (such as notebooks, YAML files, and prompts) in the source distribution. These changes ensure that users installing the package from either distribution format receive the full set of required resources.Description of changes
Moved
instruments/ into src/evaluation_instruments/to include it as part of the installable package.Updated
setup.cfgto declarepackage_dataand ensure all files underinstruments/are included in the wheel.Added
MANIFEST.into explicitly include all files ininstruments/(e.g..ipynb, .yaml, .txt) for source distribution packaging.Author Checklist
changelog/ISSUE.TYPE.rstfiles; see changelog/README.md.