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

Long_description in setup.py #696

Open
ZdenekM opened this issue Dec 29, 2021 · 1 comment
Open

Long_description in setup.py #696

ZdenekM opened this issue Dec 29, 2021 · 1 comment
Labels
enhancement New feature or request releasing

Comments

@ZdenekM
Copy link
Member

ZdenekM commented Dec 29, 2021

Currently, the long_description field is generated by concatenating README and CHANGELOG while building packages:

arcor2/pants-plugins/setup_kwargs_plugin/register.py

Line 69 in 6dab124

"long_description": f"{long_description}\n{changelog}",

However, it makes the setup.py very long (in some cases) and it would be better to put there something like:

long_description=read(README.md)

...in order to read the file content in runtime.
@ZdenekM ZdenekM added enhancement New feature or request releasing labels Dec 29, 2021
@ZdenekM
Copy link
Member Author

ZdenekM commented Jul 5, 2022

https://www.pantsbuild.org/docs/reference-python_distribution#codelong_description_pathcode

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request releasing
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@ZdenekM