python-project-template

python-project-template copied to clipboard

`sphinx_book_theme` is used by hats/hats-import/lsdb/nested-pandas and it is really nice, let's use it for everything! It would probably help with #518 and #500

hombit

It would be great if the Read the Docs HTML documentation included buttons to download notebooks (as implemented in the LSDB RTD) and to run the notebooks on Google Colab.

hombit

Virtualenv was pinned to v20.30 due to failures on the ASV workflows. See https://github.com/lincc-frameworks/python-project-template/pull/516.

camposandro

RTD template: add project's github link to every docs page

2

It could be a GitHub logo in the top right corner.

hombit

Cleaner left-hand table-of-contents for API reference

4

Looking at the HATS RTD, the menu options in the left-hand-side for the API reference have a lot of unnecessary duplication: ``` API reference └── hats ├── hats.catalog ├── hats.inspection...

delucchi-cmu

Is there a version of this template for gitlab?

3

Hi I have heard about this template, and I would like to use it in a future project, but my group uses gitlab instead of GitHub. Do you have, or...

alefisico

Enable pip caching for setup-python action?

1

The `setup-python` action supports caching of the global pip directory, so packages are not re-downloaded. We can enable it with `with: cache: 'pip'`. See the documentation [here](https://github.com/actions/setup-python?tab=readme-ov-file#caching-packages-dependencies). I’m not sure...

hombit

Support upper-case letters in project name

2

CC @delucchi-cmu

hombit

Make it easier to run pre-commit hooks

2

Currently "jupyter-nb-clear-output", "pylint", "mypy" (see also #531), "sphinx-build", and "pytest" pre-commit hooks assume that a Python environment with numerous Python executables is activated. It causes two sorts of problems: 1)...

hombit

Bumps [astral-sh/setup-uv](https://github.com/astral-sh/setup-uv) from 5 to 7. Release notes Sourced from astral-sh/setup-uv's releases. v7.0.0 🌈 node24 and a lot of bugfixes Changes This release comes with a load of bug fixes...

dependabot[bot]