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 PyPI metadata files: add setup.cfg etc #164

Merged
merged 1 commit into from
Mar 27, 2022

Conversation

jeffwidman
Copy link
Member

Update to the newer PyPI / python packaging metadata file structure.

A lot of this was cribbed from how Flask itself
exposes its metadata.

Update to the newer PyPI / python packaging metadata file structure.

A lot of this was cribbed from how [`Flask`](https://github.com/pallets/flask) itself
exposes its metadata.
@jeffwidman
Copy link
Member Author

I'm not 100% sure of all of these flags, so if anyone sees something amiss, please holler.

@jeffwidman
Copy link
Member Author

@nickjj can you take a look at this PR?

I'd like to land it before tagging a new release that incorporates #157 as this will be smoother pushing it up to PyPI.

@nickjj
Copy link
Contributor

nickjj commented Mar 26, 2022

Oh yeah, I know what you mean about not being 100% sure on the flags. This file has always been a thing for me where I get it working in 1 project after lots of experimenting and then copy / paste it in every other project I use.

With that said, I haven't used this style of setting it up but I put your PR side by side with Flask's set up and it looks good based on I don't see anything syntactically different and all of the major properties are present.

One suggestion I'd make is to bump up the python_requires version. Version 2.7 has been end of life since January 2020 and using it nowadays will be a constant battle of compatibility issues.

Flask 1.1.X requires Python 3.5+ and Flask 2.X requires Python 3.7+. Flask 2.X is less than a year old and I know plenty of folks are still using 1.X but I do know a lot of people / companies are using Python 3.7+ since anything before that has been end of life'd too. For example Python 3.5 was released in 2015 and EOL'd in 2020.

With that said, despite Python's support since this is a Flask extension what do you think about sticking with Flask's Python support? That would mean selecting Python 3.5 in this case. Folks can still use the latest and newest versions on their own, this is just the minimum version enforcement from a code compatibility point of view.

The one downside to picking 3.5 over 3.7 is it would limit this code base to using features that only exist in 3.5 or lower. For example f-strings are wildly useful but they're only available in Python 3.6+. It's not the end of the world not to have access to them but it's something to think about.

@jeffwidman
Copy link
Member Author

Yeah, it's definitely time to drop python 2 and bump the minimum version of python 3. However, that's out of scope for this PR, so I filed #165.

I was confused that you mentioned Flask 2.x requiring 3.7, when the blog post says it only requires 3.6+... https://palletsprojects.com/blog/flask-2-0-released/

But let's not chat about that here, do it over in #165

@jeffwidman jeffwidman merged commit 7f17d2c into master Mar 27, 2022
@jeffwidman jeffwidman deleted the update-pypi-metadata-files branch March 27, 2022 04:51
jeffwidman added a commit that referenced this pull request Mar 28, 2022
I fat-fingered this in
#164 so
correcting it.
Comment on lines +14 to +15
Changelog = https://github.com/jeffwidman/cqlsh#changelog
Documentation = https://github.com/flask-debugtoolbar/flask-debugtoolbar/blob/master/CHANGES.rst
Copy link
Member Author

Choose a reason for hiding this comment

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

These were both incorrect, fixed in 5eea258


[options]
packages = find:
package_dir = = flask_debugtoolbar
Copy link
Member Author

Choose a reason for hiding this comment

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

I realize this looks confusing, but I copied it straight from Flask where it's been present for 2 years: https://github.com/pallets/flask/blob/41aaaf7fa07f28ef15fd1d343142e96440889a8b/setup.cfg#L36

@github-actions github-actions bot locked as resolved and limited conversation to collaborators May 1, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Development

Successfully merging this pull request may close these issues.

2 participants