USEPA / harmonize-wq

Standardize, clean, and wrangle Water Quality Portal data into more analytic-ready formats
https://usepa.github.io/harmonize-wq/
MIT License
12 stars 5 forks source link

Review RC [doc]: environment instructions for dev #63

Closed rcaneill closed 2 months ago

rcaneill commented 4 months ago

Hi, I am starting my in-depth review and will open issues with my questions / comments on the fly.

I believe that the package is missing some instructions for devs, like:

Here is what I did, I guess it is what should be done:

# install
pip install -e .
pip install -r requirements_dev.txt

# run the tests
pytest harmonize_wq
rcaneill commented 4 months ago

cf #64 The instructions should probably be:

# install
pip install -e .
pip install -r requirements.txt
pip install -r requirements_dev.txt

# run the tests
pytest harmonize_wq
jbousquin commented 4 months ago

Hi @rcaneill - This (pip install from requirements_dev) was added to the docs contributing page on the pyOpenSci-review branch. Once that is passing, merged and the docs built does it seem adequate to close this issue?

rcaneill commented 4 months ago

It's good to see it somewhere. However, I believe that "explicit is better than implicit", and so providing the exact commands to type should be done, as in https://github.com/USEPA/harmonize-wq/issues/63#issuecomment-2074401601

I can open a PR for that, or let you do it (or if you disagree please tell me why)