python-package-guide
python-package-guide copied to clipboard
scientific Python package recommendations & guidance curated by pyOpenSci
Wandering through the tutorial guides - in the hatch guide it might be nice to add the command line example for finding the location of the config file from the...
### What was done - Added `vale` as a dependency in pyproject.toml - Remove vale config file from git-ignore - Created the folder `vale-styles` to store vale style rules -...
This PR fixes #237 and includes actions version updates for: - upload-artifact - cache - setup-python - checkout They were done as separate commits and should be easy to pickoff...
I added the steps discussed in #244 to the documentation in a drop down section because these felt like optional steps and I saw this formatting used in another location...
During the tutorial, changing the initial version in the `project.toml` to `"0.1.0"` is recommended; then, in the following example, it is listed as only `"0.1"`. https://github.com/pyOpenSci/python-package-guide/blob/7b422d4256cdb89d40c8b2b19227e4a5d8078817/tutorials/installable-code.md?plain=1#L393C1-L400C28 I'm a fan of...
Glad to see this is a TODO: https://github.com/pyOpenSci/python-package-guide/blob/a9fc8c19b1b63113fea3b66bd06177c53be2aa5a/tutorials/publish-pypi.md?plain=1#L206C1-L213C4 I will document the steps I take here; if desired, I can make a PR with changes that walk a reader through...
closes #265 https://www.pyopensci.org/python-package-guide/tutorials/get-to-know-hatch.html "Get to know hatch" tutorial's first step on a Windows system caused problems for me. So, here's how I fixed that.
The site that hosts community-built packages/channels (e.g., conda-forge & bioconda) packages is officially called "anaconda.org", not "Anaconda Cloud". (The latter is a different Anaconda Inc product.)
It was slightly confusing to have 'Migrate setup.py to a pyproject.toml' (for existing packages) in the getting started/ tutorial setup portion of the table of contents/ nav. Proposing to move...