README.md

template.py

Homepage

By Alex Brandt [email protected]

Description

You can use template.py to create a new GitHub repository. The repository has poetry, Visual Studio Code devcontainers, and various GitHub actions ready to use.

template.py relates to Cookiecutter because both are templates for bootstrapping projects. template.py allows you to have a full development environment with Visual Studio Code and it's "Remote Development" plugin. Cookiecutter expects you to re-use your development environment for projects.

Terms of use

You are free to use template.py as a basis for your own projects without any conditions. See the LICENSE file for details.

Prerequisites

1. Visual Studio Code with "Remote Development" installed
2. Shareable git credentials with the devcontainer

How to use this template

1. Visit the repository
2. Click "Use this template"
3. Follow the GitHub Docs to Create a repo
4. Open Visual Studio Code
5. Open the shell prompt with ctrl+shift+p
6. Type "clone repository in container" and press return
7. Input the GitHub URL of your new repository
8. In the resulting terminal (Ctrl+`), run: poetry run initialise
9. Resolve the generated README issue
10. Continue working on your awesome project

Documentation

• LICENSE: The license governing use of template.py

Getting help

• GitHub Issues: Support requests, bug reports, and feature requests

How to help

• Submit issues for problems or questions
• Submit pull requests for proposed changes