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

Ensure that the MANIFEST.in file includes all necessary folders #44

Merged
merged 2 commits into from
Jul 8, 2024

Conversation

huangzhii
Copy link
Collaborator

Minor improvement: Add MANIFEST.in

The MANIFEST.in file is used to include additional files and directories in the source distribution that might not be automatically included by setuptools.

For example, without MANIFEST.in, when install textgrad via

pip install git+https://github.com/zou-group/textgrad.git

and then run import textgrad, the terminal will throw below error:

>>> import textgrad
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "/opt/anaconda3/lib/python3.9/site-packages/textgrad/__init__.py", line 20, in <module>
    from .variable import Variable
  File "/opt/anaconda3/lib/python3.9/site-packages/textgrad/variable.py", line 8, in <module>
    from .utils.image_utils import is_valid_url
ModuleNotFoundError: No module named 'textgrad.utils'

Therefore, we need to include the utils/ folder in the MANIFEST.in file (in this case, recursive-include textgrad *), so that this folder can be packaged and installed correctly.

…ders. In this case, explicitly include the utils/ folder.
@huangzhii huangzhii requested a review from mertyg July 8, 2024 03:16
MANIFEST.in Outdated Show resolved Hide resolved
@mertyg mertyg merged commit d6befc6 into main Jul 8, 2024
1 check passed
@huangzhii huangzhii deleted the MANIFEST branch July 10, 2024 19:25
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