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

Update documentation, release 3.13.0 #9

Merged
merged 3 commits into from
Apr 29, 2024
Merged

Conversation

hroncok
Copy link
Member

@hroncok hroncok commented Apr 29, 2024

Related to #6

README.rst Show resolved Hide resolved
@hroncok
Copy link
Member Author

hroncok commented Apr 29, 2024

Rendered at https://test.pypi.org/project/crypt-r/

@hroncok hroncok changed the title Update documentation Update documentation, release 3.13.0 Apr 29, 2024
@hroncok
Copy link
Member Author

hroncok commented Apr 29, 2024

I think this is ready to be published. I don't like how Test PyPI renders the license file in the license field, but I think we are not doing it wrong.

hroncok and others added 3 commits April 29, 2024 13:06
@befeleme
Copy link
Contributor

befeleme commented Apr 29, 2024

I think this is ready to be published. I don't like how Test PyPI renders the license file in the license field, but I think we are not doing it wrong.

We aren't. We could also declare license.text and put the SPDX expression there which would probably be easier to digest for people looking at the PyPI page. I think setuptools would still include the license file if we don't declare the license.file key in pyproject.toml, which is what we need for distribution, per https://setuptools.pypa.io/en/latest/userguide/miscellaneous.html:

All files specified by the license-files configuration parameter in pyproject.toml and/or equivalent in setup.cfg/setup.py; note that if you don’t explicitly set this parameter, setuptools will include any files that match the following glob patterns: LICENSE*, LICENCE*, COPYING*, NOTICE*, AUTHORS**;

@befeleme
Copy link
Contributor

Other than that, the actual changes contained in this PR make sense to me, AFAICT all the suggestions for the changelog are there, render is also alright.

@hroncok
Copy link
Member Author

hroncok commented Apr 29, 2024

I don't like how Test PyPI renders the license file in the license field, but I think we are not doing it wrong.

We aren't. We could also declare license.text and put the SPDX expression there which would probably be easier to digest for people looking at the PyPI page...

I don't think it's worth it. Do you?

@befeleme
Copy link
Contributor

Not really, the benefit is microscopic.

@hroncok hroncok merged commit ff1748e into fedora-python:main Apr 29, 2024
3 checks passed
@hroncok hroncok deleted the docs branch April 29, 2024 12:23
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.

None yet

2 participants