python-package-guide icon indicating copy to clipboard operation
python-package-guide copied to clipboard

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

Open lwasser opened this issue 5 years ago • 6 comments

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 avatar Jun 03 '19 15:06 lwasser

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

choldgraf avatar May 06 '20 00:05 choldgraf

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 avatar Apr 10 '24 00:04 lwasser

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

lwasser avatar Jul 12 '24 17:07 lwasser

@lwasser

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

allcontributors[bot] avatar Jul 12 '24 17:07 allcontributors[bot]

@all-contributors please add @npch for review

lwasser avatar Jul 12 '24 17:07 lwasser

@lwasser

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

allcontributors[bot] avatar Jul 12 '24 17:07 allcontributors[bot]