Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

Cookiecutter for Sage user projects with devcontainer #34286

Open
mkoeppe opened this issue Aug 6, 2022 · 5 comments · May be fixed by #37541
Open

Cookiecutter for Sage user projects with devcontainer #34286

mkoeppe opened this issue Aug 6, 2022 · 5 comments · May be fixed by #37541

Comments

@mkoeppe
Copy link
Member

mkoeppe commented Aug 6, 2022

A cross of

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:

Cookiecutter template inspiration:

Alternative to cookiecutter:

Component: scripts

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

@mkoeppe mkoeppe added this to the sage-9.7 milestone Aug 6, 2022
@mkoeppe

This comment has been minimized.

@mkoeppe

This comment has been minimized.

@mkoeppe

This comment has been minimized.

@tobiasdiez
Copy link
Contributor

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
Copy link
Member Author

mkoeppe commented Aug 17, 2022

comment:5

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

@mkoeppe mkoeppe modified the milestones: sage-9.7, sage-9.8 Aug 31, 2022
@mkoeppe mkoeppe modified the milestones: sage-9.8, sage-9.9 Jan 7, 2023
@mkoeppe mkoeppe removed this from the sage-10.0 milestone Mar 16, 2023
@mkoeppe mkoeppe linked a pull request Mar 5, 2024 that will close this issue
5 tasks
vbraun pushed a commit to vbraun/sage that referenced this issue Mar 24, 2024
    
<!-- ^^^^^
Please provide a concise, informative and self-explanatory title.
Don't put issue numbers in there, do this in the PR body below.
For example, instead of "Fixes sagemath#1234" use "Introduce new method to
calculate 1+1"
-->
<!-- Describe your changes here in detail -->
We streamline the installation instructions for Windows by including
conda-forge instructions.

[Sage is stuck at version 9.5 in
Ubuntu](https://repology.org/project/sagemath/versions), the default
Linux distribution on WSL, so this should not be our primary
recommendation.

Preview: https://deploy-preview-37184--
sagemath.netlify.app/html/en/installation/

<!-- Why is this change required? What problem does it solve? -->
<!-- If this PR resolves an open issue, please link to it here. For
example "Fixes sagemath#12345". -->
<!-- If your change requires a documentation PR, please link it
appropriately. -->

## Alternatives / follow-ups:
- Include a link to Microsoft Store search for Linux distros -
https://www.microsoft.com/en-
us/search/shop/apps?price=0&q=linux&devicetype=pc
- Include a link to Arch WSL in Microsoft Store -
https://apps.microsoft.com/detail/9MZNMNKSM73X?hl=en-us&gl=US -- this is
the only Linux distro in the Microsoft Store that has up-to-date
SageMath packaging
- Include a link to "Import any Linux distribution to use with WSL" --
https://learn.microsoft.com/en-us/windows/wsl/use-custom-distro -- these
instructions should work with any Docker image, so many options
- Create a WSL launcher app -- https://github.com/Microsoft/WSL-
DistroLauncher, and document how users can "sideload" it --
https://learn.microsoft.com/en-us/windows/wsl/build-custom-
distro#sideloading-a-custom-linux-distro-package
- Create a WSL launcher app and publish it to the Microsoft Store --
https://github.com/Microsoft/WSL-DistroLauncher?tab=readme-ov-
file#publishing
- sagemath#34286
- sagemath#37534

### 📝 Checklist

<!-- Put an `x` in all the boxes that apply. -->
<!-- If your change requires a documentation PR, please link it
appropriately -->
<!-- If you're unsure about any of these, don't hesitate to ask. We're
here to help! -->
<!-- Feel free to remove irrelevant items. -->

- [x] The title is concise, informative, and self-explanatory.
- [x] The description explains in detail what this PR is about.
- [ ] I have linked a relevant issue or discussion.
- [ ] I have created tests covering the changes.
- [ ] I have updated the documentation accordingly.

### ⌛ Dependencies

<!-- List all open PRs that this PR logically depends on
- sagemath#12345: short description why this is a dependency
- sagemath#34567: ...
-->
- Depends on sagemath#37588 (merged here)

<!-- If you're unsure about any of these, don't hesitate to ask. We're
here to help! -->
    
URL: sagemath#37184
Reported by: Matthias Köppe
Reviewer(s): kcrisman, Matthias Köppe, Tobias Diez
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants