python-package-guide
python-package-guide copied to clipboard
pyOpenSci
scientific Python package recommendations & guidance curated by pyOpenSci
I didn’t even *see* the second table-of-contents sidebar on the right side of each page until after I’d gotten lost clicking around in the left-hand sidebar. I’m still a bit...
**Describe the bug** In "Step 5: Install your package locally," it might be nice to add steps on how to install conda or venv like how you did with installing...
"Using Hatch to Migrate setup.py to a pyproject.toml" needs to be moved from the Python Packaging Tutorial Setup nav section Link: https://www.pyopensci.org/python-package-guide/tutorials/setup-py-to-pyproject-toml.html#using-hatch-to-migrate-setup-py-to-a-pyproject-toml
**Describe the bug** When trying to install pipx for macOS as a --global option, pipx's documentation is incorrect so we should add the note to the "tip" section. If installing...
The following tip feels like the first time this tutorial has mentioned environments and managing where/which environment(s) Python packages are installed into. https://github.com/pyOpenSci/python-package-guide/blob/7b422d4256cdb89d40c8b2b19227e4a5d8078817/tutorials/get-to-know-hatch.md?plain=1#L14C1-L18C38 Consider adding a link to internal or...
I came to recommend adding information about environments / virtual environments, but you already have a TODO documented in your markdown. https://github.com/pyOpenSci/python-package-guide/blob/7b422d4256cdb89d40c8b2b19227e4a5d8078817/tutorials/installable-code.md?plain=1#L502C1-L505C4 Once you decide what documentation you want to...
This topic was brought up to me after my talk and it is important to show people how to set that up. i found setting up trusted workflows to be...
Is there a reason why this guide (only) recommends out-of-tree tests? I think having in-tree tests, especially for scientific python projects that have compiled components provide benefits, mainly that you...
I deleted duplicate content in a sentence.
This is the beginning of the translation of the tutorials page. So far there is a partial translation of the `tutorials/add-license-coc.html` page. xref: https://github.com/pyOpenSci/python-package-guide/issues/313
