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 to pyproject.toml #5

Merged
merged 3 commits into from
Jan 22, 2024
Merged

Switch to pyproject.toml #5

merged 3 commits into from
Jan 22, 2024

Conversation

silv-io
Copy link
Member

@silv-io silv-io commented Jan 22, 2024

This PR switches over the project specification to plain pyproject.toml instead of using setup.cfg, setup.py and pyproject.toml.

This is the current most up-to-date way to specify projects in Python.

The change causes minor differences in the resulting package:

$ diff SOURCES.txt /tmp/with-toml/SOURCES.txt                
4,5d3
< setup.cfg
< setup.py
18d15
< rolo.egg-info/not-zip-safe

$ diff PKG-INFO /tmp/with-toml/PKG-INFO                        
5,7c5,208
< Home-page: https://github.com/localstack/rolo
< Author: LocalStack Contributors
< Author-email: [email protected]
---
> Author-email: LocalStack Contributors <[email protected]>
> License: 
> <Comment by silv-io: Here we have the entire license file>
>         
16c217,218
< Description-Content-Type: text/markdown; charset=UTF-8
---
> Requires-Python: >=3.10
> Description-Content-Type: text/markdown

$ diff requires.txt /tmp/with-toml/requires.txt

$ diff top_level.txt /tmp/with-toml/top_level.txt

$ diff dependency_links.txt /tmp/with-toml/dependency_links.txt

Also, the file not-zip-safe is removed as well.

If it is very important, the changes to the PKG-INFO can be adapted to exactly resemble the previous version.

Regarding the not-zip-safe file, the setuptools userguide for pyproject.toml suggests that it is obsolete:

Obsolete - only relevant for pkg_resources, easy_install and setup.py install in the context of eggs (deprecated).

If we still need that, we can still add it in the toml file.

Copy link
Member

@thrau thrau left a comment

Choose a reason for hiding this comment

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

nice cleanup! 👌 just a minor thing to fix in the version descriptor

pyproject.toml Outdated Show resolved Hide resolved
@silv-io silv-io merged commit 51db7ae into main Jan 22, 2024
3 checks passed
@silv-io silv-io deleted the switch-to-pyproject-toml branch January 22, 2024 16:15
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.

2 participants