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

Step 4: A PEP517-styled quickstart user guide and room for collaboration #2146

Merged
merged 7 commits into from
May 26, 2020

Conversation

alvyjudy
Copy link
Contributor

This PR should now have incorporated/complemented what's made in #1738 and the build_meta.txt file but I will check more thoroughly on that. Please let me know there were mistakes in this documentation too:) I have tried my best to go through the source code to see how keywords in setup.cfg are handled and tested out my own examples, but there might still be things I overlooked. If there are suggestions please let me know I'm more than happy to have other people's input.

Summary of changes

Step 4 on #2093
Proposed a quickstart user guide that adheres to PEP517 and provides a brief overview on the following functionalities of setuptools, with each section pointing to another page (WIP) that covers the details and more advanced usage.

  1. installation
  2. basic use
  3. Automatic package discovery
  4. Entry points and automatic script creation
  5. Dependency management
  6. Including Data Files
  7. Uploading your package to PyPI
  8. Transitioning from setup.py to setup.cfg
  9. Resources on Python packaging

Since each section requires a more thorough documentation on the nuances and advance usage, this should make it easier for others to hop in and contribute. For example,

Pull Request Checklist

  • Changes have tests
  • News fragment added in changelog.d. See documentation for details

to make it pep517-compatible and declarative
It is now declarative and covers the following aspects of packaging:

- installation
- basic use
- package discovery
- entry points
- dependencies
- data files

Each section comprises a brief demonstration of the functionality
and provide a link to more advanced explanation
added a few sections (WIP) to make it more complete
before: pep517 build (incorrect)
now: python -m pep517.build (correct)
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