search

Billingegroup / cookiecutter

A cookie-cutter for DiffPy packages.
Other
1 stars 8 forks source link

MANIFEST.in #108

Closed Tieqiong closed 2 days ago

Tieqiong commented 3 weeks ago

It seems like MANIFEST.in need some updates

sbillinge commented 3 weeks ago

what updates?

Tieqiong commented 3 weeks ago

For example there is a requirements.txt line that we don't have. Also do we want to include doc (in the case of pdfgui we might want to, see diffpy/diffpy.pdfgui#172) instead of docs. I remember this was adapted from NSLS-II so more changes might be needed...

sbillinge commented 3 weeks ago

yes, to both those.

I guess the manifest is what is included in the release or something? How is it actually used?

Tieqiong commented 3 weeks ago

This is the related info: https://setuptools.pypa.io/en/latest/userguide/miscellaneous.html.

I also tried changing the MANIFEST.in locally and pip install, and I didn't really see what has been changed. Need to try more and see.

sbillinge commented 3 weeks ago

Thanks for this experimenting. I think we inherited this from nslsii and didn't really optimize it. Understanding what we want, and then how to get it, seems like a good conversation. I'm general, we want to deliver to users the smallest bundle that still has everything they might need

Tieqiong commented 2 weeks ago

In term of what we want to deliver, I actually think we shouldn't include the doc dir in the release, as everything there will be approachable via the deployed documentation pages. For the case of pdfgui (diffpy/diffpy.pdfgui#172) we can simply link the user to the online documentation site. Should we do this?

sbillinge commented 2 weeks ago

In term of what we want to deliver, I actually think we shouldn't include the doc dir in the release, as everything there will be approachable via the deployed documentation pages. For the case of pdfgui (diffpy/diffpy.pdfgui#172) we can simply link the user to the online documentation site. Should we do this?

I agree

sbillinge commented 3 days ago

@bobleesj don't forget to add instructions to the README about what to put in the manifest when we need to ship static files.

bobleesj commented 3 days ago

@sbillinge and I discussed and agreed that we want to export src and tests (for running cf-feedstock CI) but not doc files.