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

Use pyproject.toml for package metadata #89

Merged
merged 14 commits into from
Aug 3, 2023
Merged

Use pyproject.toml for package metadata #89

merged 14 commits into from
Aug 3, 2023

Conversation

sajith
Copy link
Member

@sajith sajith commented May 2, 2023

Addresses #45. Moves contents of setup.py and setup.cfg into pyproject.toml. Uses setuptools as the build backend.

I would like to use flit as the build backend eventually, because flit is faster and stricter and seems to be able to catch some mistakes in packaging, but that will require more changes such as #96.

sajith added 9 commits May 2, 2023 17:11
I think we can, and should, eventually switch to flit -- because flit
is faster and stricter, and because it catches more mistakes such as
when you build packages on a source tree with uncommitted changes.

But I have painted myself into a corner by the module naming
convention "src/sdx/datamodel" rather than "src/sdxdatamodel".  Flit
expects the the top-level module name to follow project name.
Setuptools is a little more forgiving, so using setuptools as build
backend for now will help us make progress.

Flit's strictness here is better because it also makes sure that
editable installs will continue to work.  With the former module
naming scheme, we have "src/sdx/datamodel" here, and "src/sdx/pce" in
pce, and because of that, we can't have editable installs in pce...
Copied over from setup.cfg and converted to toml.
@sajith sajith mentioned this pull request May 2, 2023
@sajith sajith linked an issue May 2, 2023 that may be closed by this pull request
@sajith sajith self-assigned this May 2, 2023
@coveralls
Copy link

coveralls commented May 2, 2023

Coverage Status

coverage: 71.465% (+0.1%) from 71.338% when pulling 4af6a4d on 45.pyproject-toml into cb8c653 on main.

@sajith sajith marked this pull request as ready for review August 3, 2023 15:26
@sajith sajith requested a review from YufengXin August 3, 2023 15:26
@YufengXin
Copy link
Collaborator

Does the README need to be updated?

@sajith
Copy link
Member Author

sajith commented Aug 3, 2023

Does the README need to be updated?

No. README doesn't assume any build frontend or backend or a style of metadata specification.

@sajith
Copy link
Member Author

sajith commented Aug 3, 2023

I mean, README could be updated, but not in relation to this PR. :-)

@sajith sajith merged commit fa87098 into main Aug 3, 2023
5 checks passed
@sajith sajith deleted the 45.pyproject-toml branch August 3, 2023 16:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Development

Successfully merging this pull request may close these issues.

PEP 518 packaging
3 participants