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.

Sign up for GitHub

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

Jump to bottom

Add long_description_content_type to setup in setup.py #331

Closed
rnjudge opened this issue Jun 18, 2019 · 0 comments · Fixed by #343
Closed

Add long_description_content_type to setup in setup.py #331

rnjudge opened this issue Jun 18, 2019 · 0 comments · Fixed by #343
Labels
beginner Beginner level issue bug Something went wrong CI/CD Continuous Integration and Continuous Delivery good first issue A good first issue to tackle if you are new to the project
Milestone
Release 0.5.0

Comments

@rnjudge
Copy link
Contributor

rnjudge commented Jun 18, 2019

Description
twine will not upload to pypi (or testpypi) with the current formatting of Tern's setup.py and README.md. The error I see is:

Checking distribution dist/tern-0.4.0.tar.gz: warning: long_description_content_type missing. defaulting to text/x-rst.
Failed
The project's long_description has invalid markup which will not be rendered on PyPI.

This is because the long_description reads from README.md and the expected file type is README.rst.

Implementation
Instead of converting README.md to .rst format, we can simply add the following line under long_description in setup.py:

long_description_content_type='text/markdown',

References
Add the line within setup in the file setup.py
@rnjudge rnjudge added this to the Release 0.5.0 milestone Jun 18, 2019
@rnjudge rnjudge added beginner Beginner level issue bug Something went wrong CI/CD Continuous Integration and Continuous Delivery good first issue A good first issue to tackle if you are new to the project labels Jun 18, 2019
rnjudge added a commit to rnjudge/tern that referenced this issue Jun 20, 2019
@rnjudge
Clean up PEP8 style inconsistencies in setup.py
9a7f164 
This commit makes very simple changes to address inconsistencies with
the PEP8 style in setup.py.

Specifically, this PR:
  1) Cleans up indentations where necessary.
  2) Fixes one line that was too long.
  3) Adds new lines where necessary.

By cleaning up setup.py, the next person to take on issue tern-tools#331
will not see any linting errors when they open their PR.

Signed-off-by: Rose Judge <[email protected]>
@rnjudge rnjudge mentioned this issue Jun 20, 2019
Merged
nishakm pushed a commit that referenced this issue Jun 20, 2019
@rnjudge
Clean up PEP8 style inconsistencies in setup.py
07aed34 
This commit makes very simple changes to address inconsistencies with
the PEP8 style in setup.py.

Specifically, this PR:
  1) Cleans up indentations where necessary.
  2) Fixes one line that was too long.
  3) Adds new lines where necessary.

By cleaning up setup.py, the next person to take on issue #331
will not see any linting errors when they open their PR.

Signed-off-by: Rose Judge <[email protected]>
manaswinidas added a commit to manaswinidas/tern that referenced this issue Jun 21, 2019
@manaswinidas
ci/cd:Add long_description_content_type to setup.py
0632938 
Add long_description_content_type to setup.py to avoid converting README.md to README.rst
Resolves: tern-tools#331

Signed-off-by: manaswinidas <[email protected]>
@manaswinidas manaswinidas mentioned this issue Jun 21, 2019
Merged
rnjudge pushed a commit that referenced this issue Jun 21, 2019
@manaswinidas @rnjudge
ci/cd:Add long_description_content_type to setup.py
aacef0a 
Add long_description_content_type to setup.py to avoid converting README.md to README.rst
Resolves: #331

Signed-off-by: manaswinidas <[email protected]>
rnjudge added a commit that referenced this issue Aug 28, 2019
@rnjudge
Clean up PEP8 style inconsistencies in setup.py
54381d2 
This commit makes very simple changes to address inconsistencies with
the PEP8 style in setup.py.

Specifically, this PR:
  1) Cleans up indentations where necessary.
  2) Fixes one line that was too long.
  3) Adds new lines where necessary.

By cleaning up setup.py, the next person to take on issue #331
will not see any linting errors when they open their PR.

Signed-off-by: Rose Judge <[email protected]>
rnjudge pushed a commit that referenced this issue Aug 28, 2019
@manaswinidas @rnjudge
ci/cd:Add long_description_content_type to setup.py
278aabb 
Add long_description_content_type to setup.py to avoid converting README.md to README.rst
Resolves: #331

Signed-off-by: manaswinidas <[email protected]>
rnjudge added a commit to rnjudge/tern that referenced this issue Jun 5, 2020
@rnjudge
Clean up PEP8 style inconsistencies in setup.py
c5b6911 
This commit makes very simple changes to address inconsistencies with
the PEP8 style in setup.py.

Specifically, this PR:
  1) Cleans up indentations where necessary.
  2) Fixes one line that was too long.
  3) Adds new lines where necessary.

By cleaning up setup.py, the next person to take on issue tern-tools#331
will not see any linting errors when they open their PR.

Signed-off-by: Rose Judge <[email protected]>
rnjudge pushed a commit to rnjudge/tern that referenced this issue Jun 5, 2020
@manaswinidas @rnjudge
ci/cd:Add long_description_content_type to setup.py
859640f 
Add long_description_content_type to setup.py to avoid converting README.md to README.rst
Resolves: tern-tools#331

Signed-off-by: manaswinidas <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
beginner Beginner level issue bug Something went wrong CI/CD Continuous Integration and Continuous Delivery good first issue A good first issue to tackle if you are new to the project
Projects
None yet
Milestone
Release 0.5.0
Development

Successfully merging a pull request may close this issue.

ci/cd:Add long_description_content_type to setup.py manaswinidas/tern
1 participant
@rnjudge