Skip to content

Round out Python package examples in our packaging guide #248

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

Open
ucodery opened this issue May 10, 2024 · 2 comments
Open

Round out Python package examples in our packaging guide #248

ucodery opened this issue May 10, 2024 · 2 comments
Labels
help wanted We welcome a contributor to work on this issue! thank you in advance! sprintable

Comments

@ucodery
Copy link
Collaborator

ucodery commented May 10, 2024

This guide contains a few example repos for the purpose of showing off in the docs. These examples are not yet full python projects, and should be expanded to be such, so that they can be built and give us a sense of assurance that what we show here really works.

@lwasser lwasser added the help wanted We welcome a contributor to work on this issue! thank you in advance! label May 19, 2024
@lwasser lwasser changed the title Round out example projects Round out Python package examples in our packaging guide Jul 12, 2024
@lwasser
Copy link
Member

lwasser commented Jul 12, 2024

@ucodery this is a great issue but there is not enough information for a new contributor to tackle it. Could we add more specific information to it so people know what rounding out a package specifically entails?

@ucodery
Copy link
Collaborator Author

ucodery commented Jul 15, 2024

Right now this guide has three example project meson-py, hatchling, and setuptools (none explicitly require Hatch at this time, but any can be built with Hatch). It may grow more, but only if necessary for the guide itself.

Right now they are not real projects. For example, at this time pure-setuptools has no python files. They all should be at least a buildable + installable project, and Ideally represent a real-life project (tests, lints, automation, metadata beyond minimum necessary to build). Any contributions to add new files to these projects or to make existing files more "lifelike", without reducing clarity as an example, would be welcomed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted We welcome a contributor to work on this issue! thank you in advance! sprintable
Projects
Development

No branches or pull requests

2 participants