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

Create MANIFEST.in and include requirement.txt #378

Merged
merged 1 commit into from
Jan 17, 2022

Conversation

thewchan
Copy link
Contributor

@thewchan thewchan commented Jan 15, 2022

What's Changed

Include requirement.txt in sdist but referring it in MANIFEST.in.

Technical Description

Any specific technical detail that may provide additional context to aid code review.

Before opening a Pull Request you should read and agreed to the Contributor Code of Conduct (see CONTRIBUTING.md)

@thewchan thewchan requested a review from apoclyps as a code owner January 15, 2022 16:42
@apoclyps
Copy link
Owner

apoclyps commented Jan 15, 2022

@thewchan can you please populate the pull request description for this change with details on what/why this change is being introduced?

@codecov
Copy link

codecov bot commented Jan 15, 2022

Codecov Report

❗ No coverage uploaded for pull request base (main@f381a59). Click here to learn what that means.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##             main     #378   +/-   ##
=======================================
  Coverage        ?   18.46%           
=======================================
  Files           ?       21           
  Lines           ?      612           
  Branches        ?        0           
=======================================
  Hits            ?      113           
  Misses          ?      499           
  Partials        ?        0           
Flag Coverage Δ
unittests 18.46% <0.00%> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.


Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update f381a59...5c7ea14. Read the comment docs.

@apoclyps
Copy link
Owner

I'll take a look the next day to check what should be included in the MANIFEST.in. Feel free to include these changes in your pull request if you already have any idea of what is missing.

At a glance, https://github.com/mgedmin/check-manifest looks like it could be useful for checking this in future - especially the pre-commit hook.

As for what is missing, the long description comes from the readme so it looks like it will need to be included

https://packaging.python.org/en/latest/guides/using-manifest-in/

There may even be extra files that you need to include; for example, if your setup.py computes your project’s long_description by reading from both a README and a changelog file, you’ll need to include both those files in the sdist so that people that build or install from the sdist get the correct results.

@thewchan
Copy link
Contributor Author

@apoclyps this is actually a very simple PR, nothing is changed except now requirements.txt will also be included in the source code sdist on PyPI. You can check here: https://packaging.python.org/en/latest/guides/using-manifest-in/ to see the default files included, and if you want to include/exclude certain files from the sdist.

@apoclyps apoclyps merged commit 37ab32d into apoclyps:main Jan 17, 2022
@thewchan
Copy link
Contributor Author

@apoclyps thanks so much, if it's possible please let me know when a new release is pushed to PyPI that includes this? My plan is to try putting this package on conda forge for broader exposure

@apoclyps
Copy link
Owner

awesome @thewchan; do let me know how that goes 👍

I've released 0.4.1 with this change on PyPi: https://pypi.org/project/reviews

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