Skip to content

Add instruments to manifest#9

Merged
MahmoodEtedadi merged 8 commits intomainfrom
metedadi/add-instruments-to-manifest
Jul 16, 2025
Merged

Add instruments to manifest#9
MahmoodEtedadi merged 8 commits intomainfrom
metedadi/add-instruments-to-manifest

Conversation

@MahmoodEtedadi
Copy link
Contributor

@MahmoodEtedadi MahmoodEtedadi commented Jul 15, 2025

Overview

This PR restructures the repository to ensure that all files under the instruments/ folder are included in both the wheel (.whl) and source (.tar.gz) distributions. To achieve this, the instruments/ directory has been moved into src/evaluation_instruments/, making it part of the package namespace and accessible at runtime. The setup.cfg has been updated to include the folder’s contents during wheel builds by configuring the package_data section. Additionally, MANIFEST.in has 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.cfg to declare package_data and ensure all files under instruments/ are included in the wheel.

  • Added MANIFEST.in to explicitly include all files ininstruments/ (e.g. .ipynb, .yaml, .txt) for source distribution packaging.

Author Checklist

  • Linting passes; run early with pre-commit hook.
  • Tests added for new code and issue being fixed.
  • Added type annotations and full numpy-style docstrings for new methods.
  • Draft your news fragment in new changelog/ISSUE.TYPE.rst files; see changelog/README.md.

@MahmoodEtedadi MahmoodEtedadi requested a review from a team as a code owner July 15, 2025 15:30
@MahmoodEtedadi MahmoodEtedadi requested a review from diehlbw July 15, 2025 15:31
@diehlbw
Copy link
Contributor

diehlbw commented Jul 15, 2025

Do we need any changes to the top-level README?
My thought is it would be a description of the vcs-install usecase; especially if calling instruments programatically (not an ipynb) than it may be better to do the pip install git+https (+ tag)

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
Copy link
Contributor

Choose a reason for hiding this comment

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

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

Copy link
Contributor Author

@MahmoodEtedadi MahmoodEtedadi Jul 15, 2025

Choose a reason for hiding this comment

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

Updated. We should probably change the convention to vX.Y.Z for future tags. maybe even re-tag 0.0.1.

@MahmoodEtedadi MahmoodEtedadi requested a review from diehlbw July 15, 2025 21:22
Co-authored-by: diehlbw <36572844+diehlbw@users.noreply.github.com>
@MahmoodEtedadi MahmoodEtedadi requested a review from diehlbw July 16, 2025 16:19
@MahmoodEtedadi MahmoodEtedadi merged commit d6375b8 into main Jul 16, 2025
4 of 5 checks passed
@MahmoodEtedadi MahmoodEtedadi deleted the metedadi/add-instruments-to-manifest branch July 16, 2025 22:27
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.

2 participants