<!-- vale RedHat.Headings = NO -->
# template.py
<!-- vale RedHat.Headings = YES -->
[Homepage][repository]
By Alex Brandt <alunduil@gmail.com>
## 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
1. [Shareable git credentials with the devcontainer](https://code.visualstudio.com/remote/advancedcontainers/sharing-git-credentials)
## How to use this template
1. Visit [the repository][repository]
1. Click "Use this template"
1. Follow the GitHub Docs to [Create a repo][create a repo]
1. Open Visual Studio Code
1. Open the shell prompt with `ctrl+shift+p`
1. Type "clone repository in container" and press return
1. Input the GitHub URL of your new repository
1. In the resulting terminal (Ctrl+\`), run: `poetry run initialise`
1. Resolve the generated README issue
1. Continue working on your awesome project
## Documentation
* [LICENSE]: The license governing use of template.py
## Getting help
* [GitHub Issues][issues]: Support requests, bug reports, and feature requests
## How to help
* Submit [issues] for problems or questions
* Submit [pull requests] for proposed changes
[create a repo]: https://docs.github.com/en/get-started/quickstart/create-a-repo
[issues]: https://github.com/alunduil/template.py/issues
[LICENSE]: ./LICENSE
[pull requests]: https://github.com/alunduil/template.py/pulls
[repository]: https://github.com/alunduil/template.py
[Cookiecutter]: https://github.com/cookiecutter/cookiecutter
Raw data
{
"_id": null,
"home_page": "https://github.com/alunduil/template.py",
"name": "templatise",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.9",
"maintainer_email": null,
"keywords": "python, template, vscode, devcontainers",
"author": "Alex Brandt",
"author_email": "alunduil@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/ff/71/646099e9ec7a2e61047ce062866c43c359a62fd14c4fce88d3b493cc83c5/templatise-2.3.1.tar.gz",
"platform": null,
"description": "<!-- vale RedHat.Headings = NO -->\n# template.py\n<!-- vale RedHat.Headings = YES -->\n\n[Homepage][repository]\n\nBy Alex Brandt <alunduil@gmail.com>\n\n## Description\n\nYou can use template.py to create a new GitHub repository. The repository has\npoetry, Visual Studio Code devcontainers, and various GitHub actions ready to use.\n\ntemplate.py relates to [Cookiecutter] because both are templates for\nbootstrapping projects. template.py allows you to have a full development\nenvironment with Visual Studio Code and it's \"Remote Development\" plugin.\n[Cookiecutter] expects you to re-use your development environment for\nprojects.\n\n## Terms of use\n\nYou are free to use template.py as a basis for your own projects without any\nconditions. See the [LICENSE] file for details.\n\n## Prerequisites\n\n1. Visual Studio Code with \"Remote Development\" installed\n1. [Shareable git credentials with the devcontainer](https://code.visualstudio.com/remote/advancedcontainers/sharing-git-credentials)\n\n## How to use this template\n\n1. Visit [the repository][repository]\n1. Click \"Use this template\"\n1. Follow the GitHub Docs to [Create a repo][create a repo]\n1. Open Visual Studio Code\n1. Open the shell prompt with `ctrl+shift+p`\n1. Type \"clone repository in container\" and press return\n1. Input the GitHub URL of your new repository\n1. In the resulting terminal (Ctrl+\\`), run: `poetry run initialise`\n1. Resolve the generated README issue\n1. Continue working on your awesome project\n\n## Documentation\n\n* [LICENSE]: The license governing use of template.py\n\n## Getting help\n\n* [GitHub Issues][issues]: Support requests, bug reports, and feature requests\n\n## How to help\n\n* Submit [issues] for problems or questions\n* Submit [pull requests] for proposed changes\n\n[create a repo]: https://docs.github.com/en/get-started/quickstart/create-a-repo\n[issues]: https://github.com/alunduil/template.py/issues\n[LICENSE]: ./LICENSE\n[pull requests]: https://github.com/alunduil/template.py/pulls\n[repository]: https://github.com/alunduil/template.py\n[Cookiecutter]: https://github.com/cookiecutter/cookiecutter\n",
"bugtrack_url": null,
"license": "Unlicense",
"summary": "You can use template.py to create a new GitHub repository.",
"version": "2.3.1",
"project_urls": {
"Homepage": "https://github.com/alunduil/template.py",
"Repository": "https://github.com/alunduil/template.py"
},
"split_keywords": [
"python",
" template",
" vscode",
" devcontainers"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "877379260c923ac2c50cf69dea33c8105af6c44f8b6ed89278c79954f67612a9",
"md5": "b0373297a2578f55da240f71510caa9c",
"sha256": "87a83a0d491f4d74a1b67f64289e49c1a36877662fc643d48015548b6775b9ee"
},
"downloads": -1,
"filename": "templatise-2.3.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b0373297a2578f55da240f71510caa9c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.9",
"size": 39787,
"upload_time": "2024-12-15T14:34:39",
"upload_time_iso_8601": "2024-12-15T14:34:39.328986Z",
"url": "https://files.pythonhosted.org/packages/87/73/79260c923ac2c50cf69dea33c8105af6c44f8b6ed89278c79954f67612a9/templatise-2.3.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ff71646099e9ec7a2e61047ce062866c43c359a62fd14c4fce88d3b493cc83c5",
"md5": "f71c67ad467e713b105a4fb72d70dfaa",
"sha256": "a50840c4a3931a43fd69ede644b51e2b1d096f2fd809c598fae912608141a75b"
},
"downloads": -1,
"filename": "templatise-2.3.1.tar.gz",
"has_sig": false,
"md5_digest": "f71c67ad467e713b105a4fb72d70dfaa",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.9",
"size": 38282,
"upload_time": "2024-12-15T14:34:40",
"upload_time_iso_8601": "2024-12-15T14:34:40.485556Z",
"url": "https://files.pythonhosted.org/packages/ff/71/646099e9ec7a2e61047ce062866c43c359a62fd14c4fce88d3b493cc83c5/templatise-2.3.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-15 14:34:40",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "alunduil",
"github_project": "template.py",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "templatise"
}
JSON
