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

Switch setup.py/.cfg to pyproject.toml, add docs link/readme #63

Merged
merged 2 commits into from
Mar 17, 2025

Conversation

DeflateAwning
Copy link
Contributor

  • Main change: Switched from setup.py and setup.cfg to pyproject.toml. Maintained the setuptools build system though, instead of switching to something like Hatch (as discussed in Convert to pyproject.toml project file #60)
  • Other fix: Added the docs link to the PyPI page
  • Other fix: Registered the readme and license.txt files correctly so that they appear on PyPI

Fixes #60

name = "FreeSimpleGUI"
version = "5.2.0"
description = "The free-forever Python GUI framework."
readme = {file = "README.md", content-type = "text/markdown"}
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In the original setup.cfg, I believe this was a typo. Probably why the description doesn't show on PyPI. Let's correct it here.

Suggested change
readme = {file = "README.md", content-type = "text/markdown"}
readme = {file = "readme.md", content-type = "text/markdown"}

Alternatively, we can rename readme.md to README.md.

@DeflateAwning
Copy link
Contributor Author

Great catch, thanks! Just renamed the README to the standard README.md

@spyoungtech spyoungtech merged commit c20e079 into spyoungtech:main Mar 17, 2025
1 check passed
@spyoungtech
Copy link
Owner

Awesome. Thanks for the contribution. I'll try and get a post release out shortly.

@DeflateAwning DeflateAwning deleted the pyproject-convert branch March 17, 2025 23:38
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.

Convert to pyproject.toml project file
2 participants