python-package-guide

python-package-guide copied to clipboard

In our packaging guide, we teach creating a package using the template It would be nice to add this cheatsheet to the list of resources https://hackmd.io/R9r52vtOS0aMCUA03tOheA

lwasser

I'm trying to make opengraph happy as it can't find japanese fonts. this pr 1. tries to add a fallback noto sans JP to the build to make rendering better...

lwasser

Treat warnings as errors when building in CI

2

I think it's probably a good idea to treat warnings as errors to avoid simple mistakes - e.g. currently there is an admonition that uses an invalid `color` parameter: https://github.com/pyOpenSci/python-package-guide/blob/c4877898915d24b6be60d35f76a2b67c8311fdc8/tutorials/publish-pypi.md?plain=1#L215...

sneakers-the-rat

feat: add implementation pages in the guidebook to support peer review

4

In our slack, @coatless made some great suggestions as our current Editor in Chief regarding gaps in our guidebook related to our peer review process and how things could be...

lwasser

The emphasized text is not rendering correctly in Japanese document

1

https://www.pyopensci.org/python-package-guide/ja/package-structure-code/pyproject-toml-python-package-metadata.html#use-a-pyproject-toml-file-for-your-package-configuration-metadata

tkoyama010

Clarify recommended use of `requires-python`

3

I realize this PR was opened just to add new guidance, but we should really update this paragraph to specify that, even with lower bounds, `requires-python` is not necessary for...

ucodery

This issue is a result of https://github.com/pyOpenSci/python-package-guide/issues/504 Where we determined that using NOTO SANS JP as a fall back font in our guide might fix the Japanese character issue. We...

lwasser