Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove docs and paper data/code from release #99

Merged
merged 1 commit into from
Apr 24, 2024

Conversation

matjobst
Copy link
Collaborator

@matjobst matjobst commented Apr 23, 2024

This is a fix for #98
There is no way to remove stuff from the source distribution using a config inside pyproject.toml as long as we are using setuptools_scm (see pypa/setuptools-scm#190). As soon as setuptools_scm is used, all data which is under version control is added. The solution proposed by the authors of setuptools_scm is to add a MANIFEST.in.
In the MANIFEST.in, I remove the docs and the paper folders as these should not be required for a source distribution via pypi.
Additrionally I added find={include = ["nir*"]} in the pyproject.toml which will cause only the nir folder to be added to the wheel (the other files should not be required).
I tested it locally and it seems to work. But please also check it, @Jegp .
Resulting sizes are ~19 kB for the wheel and 25 kB for the source.

@matjobst matjobst requested a review from Jegp April 23, 2024 08:26
Copy link
Collaborator

@Jegp Jegp left a comment

Choose a reason for hiding this comment

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

Excellent work @matjobst! Great catch. I suggest we just merge it as-is and release. Would you be ok seeing that through? After the changes here, it should be as simple as just pushing a release with a new tag.

@matjobst matjobst merged commit 8f9177e into main Apr 24, 2024
4 checks passed
@matjobst matjobst deleted the rm_notebooks_and_paper branch April 24, 2024 15:28
@matjobst
Copy link
Collaborator Author

Its released as version 1.0.4 now. Looks good on pypi. A trial install also worked without any immediate issues.

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