Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

update global structure ? #24

Open
12rambau opened this issue Jun 26, 2023 · 3 comments
Open

update global structure ? #24

12rambau opened this issue Jun 26, 2023 · 3 comments

Comments

@12rambau
Copy link
Member

12rambau commented Jun 26, 2023

I started to use cookiecutter for various things and I didn't realized there was a specific one for extentions. Would you be interested in updating the strucure to more modern Python ?

  • use pre-commits
  • use github actions
  • rely on a single pyproject.toml file
  • add config to build documentation (with default pages like landing, contribute, API)
@stephenfin
Copy link
Member

Sure, go for it.

@daquintero
Copy link

daquintero commented Jan 11, 2024

Basically sorted in #25

@12rambau
Copy link
Member Author

sorry @daquintero for washing away some of your effort I didn't saw you started working on my issue. In short I moved away from cookicutter as it was not allowing me to update my packages when I was discovering new things about python envirnment e.g. :

  • setuptools -> hatchling
  • tox -> nox
  • flake8 -> ruff

To reflect that I created a copier template for sphinx based extention and saved it here: https://github.com/sphinx-contrib/copier-sphinxcontrib

I also published a skeleton extention here applying as much as possible the instructions of the readme: https://github.com/sphinx-contrib/sphinxcontrib-skeleton

I would be curious to get your feedback on both and see with @stephenfin if it would make sense to archive this repository in favor of the copier template (this is what we did in jupyter for lab plugins)

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants