https://github.com/sopel-irc/cookiecutter-sopel
Cookiecutter template for Sopel plugins
https://github.com/sopel-irc/cookiecutter-sopel
Last synced: 7 months ago
JSON representation
Cookiecutter template for Sopel plugins
- Host: GitHub
- URL: https://github.com/sopel-irc/cookiecutter-sopel
- Owner: sopel-irc
- Created: 2015-08-30T15:55:16.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2024-09-17T18:09:55.000Z (9 months ago)
- Last Synced: 2024-09-17T22:28:53.144Z (9 months ago)
- Language: Python
- Homepage:
- Size: 29.3 KB
- Stars: 3
- Watchers: 3
- Forks: 9
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# cookiecutter-sopel
Plugin template for Sopel 7 and higher. To use:
```sh
pip install cookiecutter
cookiecutter gh:sopel-irc/cookiecutter-sopel
```
You can then release the plugin on PyPI in the normal Python way.
Obviously, you can modify anything that the template builds, so don't feel
constrained to this one way of doing things. Please do submit PRs to this repo
if you think the template can be improved.
## Setting defaults (name, email, username)
If you find yourself creating plugins fairly often, you'll likely get tired of
typing in your name, email address, and GitHub username every time.
Fortunately, cookiecutter itself provides a way to specify default values via a
`.cookiecutterrc` file in your home directory. For example, this snippet:
```yaml
default_context:
full_name: "dgw"
email: "[email protected]"
github_username: "dgw"
```
would override the default values for this template's `full_name`, `email`, and
`github_username` fields, meaning you could just press Enter to accept each of
these instead of retyping your info every time.
Read more [in cookiecutter's documentation][cookiecutter-user-config].
[cookiecutter-user-config]: https://cookiecutter.readthedocs.io/en/latest/advanced/user_config.html
## Legacy module template
If you need to build a new plugin that will be compatible with Sopel 6, use the
legacy template:
```sh
pip install cookiecutter
cookiecutter gh:sopel-irc/cookiecutter-sopel --checkout sopel_modules
```