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

rewrite installation section to use pyproject.toml #332

Merged
merged 2 commits into from
Aug 8, 2024

Conversation

sjvrijn
Copy link
Contributor

@sjvrijn sjvrijn commented Aug 1, 2024

Changes in this PR

fixes #326

The section on creating an installable package has been rewritten to only assume pyproject.toml as the relevant file to specify everything in. I've also been a bit more elaborate about what is in pyproject.toml, since the build system landscape is a bit more stable than it used to be when this was originally written. Speaking of build-system, I've explicitly mentioned hatchling and setuptools as our recommendations, with a link to e.g. the python packaging guide for other options.

Checklist

SIGNIFICANT changes / additions, e.g. new chapters

  • I discussed my contribution in an issue and took into account feedback.

ALL contributions

  • I previewed my changes locally using e.g. python3 -m http.server 4000 and confirmed they work correctly.
  • I checked for broken links, e.g. using the link checker GitHub Action workflow, or locally by using docker run --init -it -v pwd:/docs lycheeverse/lychee /docs --config=docs/lychee.toml, at least for the files I changed.
  • My name was added to the CITATION.cff file.

Copy link
Member

@bouweandela bouweandela left a comment

Choose a reason for hiding this comment

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

Thanks!

@bouweandela bouweandela merged commit 6edf262 into main Aug 8, 2024
1 check passed
@bouweandela bouweandela deleted the 326-setup-cfg-to-pyproject-toml branch August 8, 2024 09:17
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.

Update Python Packaging section to use pyproject.toml instead of setup.cfg
2 participants