Move long description logic from info.py to setup.py #670
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
tsalo
reviewed
Feb 3, 2021
|
@notZaki looks like CircleCI is having dockerhub issues; you'll probably need to wait until those issues resolve and then push an empty commit in order to correctly trigger tests on Circle. |
Codecov Report
@@ Coverage Diff @@
## main #670 +/- ##
=======================================
Coverage 93.64% 93.64%
=======================================
Files 26 26
Lines 2030 2030
=======================================
Hits 1901 1901
Misses 129 129
Continue to review full report at Codecov.
|
|
@notZaki do you want to add yourself to the Zenodo file in this PR? |
|
@tsalo I'll open another PR later today with a minor change for getting tests to work on windows, and I can add myself then. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
References #668
The
README.mdfile is used as the module's long description. The relevant code is defined intedana/info.py. This causes an error when importing the module because it tries to load the readme file, but the readme file does not get copied over once the module is installedThis PR moves the relevant code to
setup.pyso that the readme file is only read when the module is first being installed. This should get rid of the error. Remains to be seen if the long description will correctly show up on pypi.