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

Update packaging: add MANIFEST.in and py.typed #111

Merged
merged 2 commits into from
May 5, 2024

Conversation

sugatoray
Copy link
Contributor

@sugatoray sugatoray commented Apr 30, 2024

This PR addresses the following two aspects of pypi-packaging. It will help also with conda-forge packaging.

Add MANIFEST.in file

  • this allows complete clarity and declarative specification of what to include or exclude in the packaging

🔥 NOTE: currently the following two files are missing from the .tar.gz aource on PyPI:

  • LICENSE file

    The license file is necessary for conda-forge packaging as well.

  • requirements.txt file

    The setup.py file looks for the requirements.txt file and since it's not present throws an error while trying to install from the downloaded .tar.gz source file.

💡 NO requirements.txt or py.typed FILE INCLUDED
image

Add py.typed file

This will enable support for type hinting in editors according to PEP-561.

The py.typed file is supposed to be an empty file placed inside the package folder auto_ts.

- this allows complete clarity and declarative specification of what to include or exclude in the packaging
@sugatoray
Copy link
Contributor Author

sugatoray commented Apr 30, 2024

cc: @AutoViML

Question:

I see that you are excluding tests folder inside setup.py (line-16), however, I do not see there is any folder by that name under the root of the repository. Am I missing something?
Or, did you mean to exlude auto_ts/test folder?

image

@AutoViML AutoViML merged commit b1e5ff5 into AutoViML:master May 5, 2024
@AutoViML
Copy link
Owner

AutoViML commented May 5, 2024

Ok done thanks @sugatoray 👍

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.

Add requirements.txt and LICENSE file to tar.gz source on PyPI
2 participants