python-package-guide
python-package-guide copied to clipboard
pyOpenSci
scientific Python package recommendations & guidance curated by pyOpenSci
In this Pr it was noted that while changelog is shown in the example Python package structure ([see here](https://github.com/pyOpenSci/python-package-guide/pull/82/files#diff-c9e710a4cf5be8032c2548680f945cfdb53dad0accae7aeefe8d3568afd12dc4R61)) it is not mentioned in the documentation docs section. So we...
this was inspired by @Zeitsperre comment around how the python version badge is created > there are two ways of indicating the compatibility of Python for a package; classifiers is...
If you use hatch, it will migrate a setup.py file or setup.cfg metadata to a pyproject.toml file for you. I had originally created a tutorial for this in [this pr](https://github.com/pyOpenSci/python-package-guide/pull/171/files#diff-dc445ab5677db4a15c5246b985b7d658a7121353d74a9aca98735f6471a5cb60)...
Currently the license guide only mentions permissive licenses without discussing what the alternative might be. I think this is a relatively balanced discussion that provides some links to further readings...
> i think that makes a lot of sense to frame it . do you want to make that change to the file? This is also making me think that...
This pr is the final piece of content from the now closed pr #104 that was opened in september. it contains 2 short pages 1. describing CI 2. overviewing code...
From the [Bug Bash conversation](https://github.com/pyOpenSci/python-package-guide/pull/120#discussion_r1437291602) with @lwasser: ``` * [jupyterbook has one!](https://jupyterbook.org/en/stable/reference/glossary.html) * https://raw.githubusercontent.com/executablebooks/jupyter-book/master/docs/reference/glossary.md and it looks like there is a sphinx [glossary directive](https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#glossary) we can employ as well. we...
Hi and thanks for your great guide! 🚀 I'm finding it very useful as I navigate switching from `setup.py` 💯 This question is sparked from a [package review](https://github.com/LabForComputationalVision/plenoptic/issues/104) and some...
In our guidebook review @Midnighter noted that we have a lot of external links to content that will take people away from our guidebook. in many cases it is external...
We had some discussion around the test lessons and adding content on caching for deps in CI. see: * https://github.com/pyOpenSci/python-package-guide/pull/145/files#r1442119731 For simplicity sake - and to keep the page beginner...