Skip to content

Add tests for example packages in our python packaging guide #249

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 · 4 comments
Open

Add tests for example packages in our python packaging guide #249

ucodery opened this issue May 10, 2024 · 4 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

After #248 we will have real example projects to pull from in docs. These projects should all be tested so that they remain a set of accurate and meaningful examples.

Each project should be tested via a nox session which will verify that each can be: built, installed, imported, run

This nox session should also be run during CI.

@lwasser lwasser added the help wanted We welcome a contributor to work on this issue! thank you in advance! label May 19, 2024
@lwasser
Copy link
Member

lwasser commented May 19, 2024

also please see our examplePy repo where i began to create example packages! And #252 ... we've come a long way since i started working on examplePy which is so so awesome! 💟 community 💟

@lwasser
Copy link
Member

lwasser commented Jul 12, 2024

i'm pulling this from our help wanted board as well until this issue is more specific so someone could work on it. @ucodery if you have time to add a bit more detail that would be wonderful!

@lwasser lwasser changed the title Test example projects Add tests for example packages in our python packaging guide Jul 12, 2024
@ucodery
Copy link
Collaborator Author

ucodery commented Jul 15, 2024

Ideally this guide would not host any example projects that

  1. do not build a distribution artifact
  2. are not installable or at all usable (if it installs but gives SyntaxError 100% of the time)
  3. does not pass its own test suite
  4. does not pass its own static analysis or other pre/post commit checks
  5. cannot build its own documentation

In order to guarantee all of this, each of these cleanliness checks needs to be done for each example project as part of the larger guide's checks.

@jrrickerson
Copy link

I'm going to try taking a crack at this during the PyCon US 2025 sprints.

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
Status: No status
Development

No branches or pull requests

3 participants