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

Add: tutorial on how to setup a Python testing envt using hatch to our tutorials #238

Open
lwasser opened this issue Jun 3, 2019 · 6 comments
Labels
help wanted We welcome a contributor to work on this issue! thank you in advance! sprintable

Comments

@lwasser
Copy link
Member

lwasser commented Jun 3, 2019

This follows @npch comment here: https://pyopensci.discourse.group/t/some-experiences-of-doing-a-pyopensci-review/29/2?u=lwasser

Essentially someone newer to package development might not know how to setup a Python Envt with items needed to run tests locally. We should add a tutorial in the tutorial section of our guidebook that teaches someone to setup and run tests.

I think it should include a tutorial on setting up testing environments with hatch (i created a nice tutorial on the hatch docs on environments for reference here!).

I think the sections would look something like

  1. What is testing / why is it important?
  2. What is a python envt? why is it useful and how (one way to) set one up?
  3. What to look for in contributing guidelines for this setup information
@lwasser lwasser added the help wanted We welcome a contributor to work on this issue! thank you in advance! label Jun 3, 2019
@lwasser lwasser changed the title Add content on how to setup a Python testing envt Add tutorial on how to setup a Python testing envt Jun 3, 2019
@choldgraf
Copy link

Note - I added another page for this so that we could expand upon it with content like the one described here:

https://www.pyopensci.org/dev_guide/authoring/testing.html

One thing to note is that we don't want to re-invent the wheel. We should link out to things like software carpentry as much as possible

@lwasser
Copy link
Member Author

lwasser commented Apr 10, 2024

Wow - this is a really old issue! BUT i think this would be a good addition tl our packaging guide tutorials using hatch the setup is actually really straight forward. i'm going to move this to the other repo, tag it as help-wanted.

i'll also update the top header to be more specific

@lwasser lwasser changed the title Add tutorial on how to setup a Python testing envt Add: tutorial on how to setup a Python testing envt using hatch to our tutorials Apr 10, 2024
@lwasser lwasser transferred this issue from pyOpenSci/software-peer-review Apr 10, 2024
@lwasser
Copy link
Member Author

lwasser commented Jul 12, 2024

@all-contributors pleaes add @choldgraf for code, review

Copy link
Contributor

@lwasser

I've put up a pull request to add @choldgraf! 🎉

@lwasser
Copy link
Member Author

lwasser commented Jul 12, 2024

@all-contributors please add @npch for review

Copy link
Contributor

@lwasser

I've put up a pull request to add @npch! 🎉

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: Python Package Guide
Development

No branches or pull requests

2 participants