Cookiecutter for Sage user projects with devcontainer

[mkoeppe]

A cross of

• https://github.com/ilyasotkov/vscode-devcontainer-python-cookiecutter
• https://github.com/mmasdeu/sage_package_template

The devcontainer config would be one of those added in #33671 (sagemath-sage or downstream-...).

Prospective sage users on Windows can use the devcontainer config to automate the Sage install in WSL. VS Code walks you through this.

Also a command sage --cookiecutter or sage --new-project could be added.

Cookiecutter details:

• https://cookiecutter.readthedocs.io/en/2.6.0/advanced/templates.html
• https://cookiecutter.readthedocs.io/en/2.6.0/advanced/directories.html - symlinks for files are OK
• https://cookiecutter.readthedocs.io/en/2.6.0/advanced/calling_from_python.html

Cookiecutter template inspiration:

• https://github.com/audreyfeldroy/cookiecutter-pypackage/tree/master/%7B%7Bcookiecutter.project_slug%7D%7D
• https://github.com/cjolowicz/cookiecutter-hypermodern-python

Alternative to cookiecutter:

• https://cruft.github.io/cruft/ (compatible with cookiecutter, has update mechanism)

• https://marketplace.visualstudio.com/items?itemName=cantonios.project-templates

• Getting a devcontainer template for Sage into https://github.com/microsoft/vscode-dev-containers/tree/main/containers ..... this has been replaced by https://github.com/devcontainers/templates

• github's template repo https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-template-repository; perhaps combined with https://github.com/marketplace/actions/actions-template-sync

Component: scripts

Issue created by migration from https://trac.sagemath.org/ticket/34286

[mkoeppe]

Description changed:

--- 
+++ 
@@ -8,3 +8,4 @@

 Also a command `sage --cookiecutter` could be added.

+Alternative to cookiecutter: https://marketplace.visualstudio.com/items?itemName=cantonios.project-templates

[mkoeppe]

Description changed:

--- 
+++ 
@@ -6,6 +6,6 @@

 Prospective sage users on Windows can use the devcontainer config to automate the Sage install in WSL. VS Code walks you through this.

-Also a command `sage --cookiecutter` could be added.
+Also a command `sage --cookiecutter` or `sage --new-project` could be added.

 Alternative to cookiecutter: https://marketplace.visualstudio.com/items?itemName=cantonios.project-templates

[mkoeppe]

Description changed:

--- 
+++ 
@@ -8,4 +8,8 @@

 Also a command `sage --cookiecutter` or `sage --new-project` could be added.

-Alternative to cookiecutter: https://marketplace.visualstudio.com/items?itemName=cantonios.project-templates
+Alternative to cookiecutter: 
+- https://marketplace.visualstudio.com/items?itemName=cantonios.project-templates
+
+- Getting a devcontainer template for Sage into https://github.com/microsoft/vscode-dev-containers/tree/main/containers 
+

[tobiasdiez]

comment:4

Since the template consists mostly in static files, it should be enough to use github's template repo https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-template-repository

[mkoeppe]

comment:5

That's a great idea, I forgot about those!