Skip to content

add a MANIFEST.in file #72

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

Merged
merged 1 commit into from
Jun 11, 2025
Merged

Conversation

ocefpaf
Copy link
Member

@ocefpaf ocefpaf commented Jun 10, 2025

Implements #71 (comment) for now.

Comment on lines +9 to +10
prune docs
prune tests
Copy link
Member Author

Choose a reason for hiding this comment

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

I want to reduce the docs size by solving #71 and we should probably either move the tests to the package or never ship them, otherwise they'll be their own namespace.

Copy link
Contributor

Choose a reason for hiding this comment

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

we should probably either move the tests to the package or never ship them, otherwise they'll be their own namespace.

I don't follow -- I think they should be in the sdist, but not installed as part of the package (so not in a wheel).

I think this should do that:

[tool.setuptools]
packages = ["xarray"]

but if not, then we need to fix that.

Copy link
Contributor

Choose a reason for hiding this comment

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

NOTE: moving them into the package is a fine idea, but not until we resolve the data files issue.

Copy link
Member Author

Choose a reason for hiding this comment

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

Putting them in the sdist with a __init__py will make it a package named tests, installable via pip* or not.

* NB the packages = [ "xarray_subset_grid" ] ensures it is not installed, it is still a package named "tests" for many other tools that inspects this codebase.

Copy link
Contributor

Choose a reason for hiding this comment

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

Only tools that try to auto-detect packages -- and why would anyone use those as is? this pyproject file is specifically for setuptools [*].

packages = [ "xarray_subset_grid" ] ensures it is not installed,

Not really -- it tells setuptools what to put in the wheel, when the wheel is built. pip just installs that wheel (or if you point it at source, it calls setuptools to build the wheel first, and then installs it)

In the end, we might want to put the tests inside the package (but maybe not -- there should be many more! But for now, it's OK as is -- this isn't a 1.0 release :-)

[*] setuptools is getting pretty clunky, maybe it's time to go to hatch ...

prune .github
prune *.egg-info
prune docs
prune tests
Copy link
Contributor

Choose a reason for hiding this comment

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

I don't think we should prune the tests -- it's nice to have them in the sdist. (among other things, you can run them when building a conda package, for instance)

Copy link
Contributor

Choose a reason for hiding this comment

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

scratch that -- the tests need data files that are in the docs/examples dir -- so let's leave them out for now after all.

This all needs a lot of restructuring ...

@ChrisBarker-NOAA ChrisBarker-NOAA merged commit 7e60c7c into ioos:main Jun 11, 2025
13 of 14 checks passed
@ChrisBarker-NOAA
Copy link
Contributor

sdist now 250k

:-)

@ocefpaf ocefpaf deleted the add_manifest.in branch June 11, 2025 10:44
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