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

make abstract distinct from description and summary #53

Open
broeder-j opened this issue Oct 30, 2023 · 0 comments
Open

make abstract distinct from description and summary #53

broeder-j opened this issue Oct 30, 2023 · 0 comments
Labels
enhancement New feature or request

Comments

@broeder-j
Copy link
Member

Is your feature request related to a problem? Please describe.
Currently, somesy.toml allows to set a description key value, this will get put into the CITATION.cff as abstract and into codemeta and pyproject.toml as description.

Python project metadata description corresponds to package metadata summary, which is limited on pypi to be < 512 chars.
(https://packaging.python.org/en/latest/specifications/declaring-project-metadata/#description)

Therefore, if one wants to put a real abstract into the CITATION.cff, it should not be synced with the pyproject.toml description, otherwise the package is not uploadable to pypi.

Describe the solution you'd like
I suggest to allow for an optional 'abstract' keyword in somesy.toml, which defaults to a given value under the description key if provided.

@broeder-j broeder-j added the enhancement New feature or request label Oct 30, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant