https://github.com/ladybug-tools/ladybug-tools-template
Use this repository as a template to start a new ladybug tools python module
https://github.com/ladybug-tools/ladybug-tools-template
Last synced: 4 months ago
JSON representation
Use this repository as a template to start a new ladybug tools python module
- Host: GitHub
- URL: https://github.com/ladybug-tools/ladybug-tools-template
- Owner: ladybug-tools
- Created: 2019-01-27T00:05:34.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-10-16T22:52:57.000Z (over 1 year ago)
- Last Synced: 2025-09-08T22:07:16.766Z (9 months ago)
- Language: Python
- Homepage:
- Size: 81.1 KB
- Stars: 3
- Watchers: 5
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Ladybug Tools Template
Use this repository as a template to write a new modules for Ladybug Tools.
## QuickStart
1. Install [cookiecutter](https://cookiecutter.readthedocs.io/en/latest/readme.html) and [pygithub](https://pygithub.readthedocs.io/en/latest/introduction.html) (to automate creating the repositories on Github after generating them locally)
```console
pip install cookiecutter pygithub
```
2. Run cookiecutter against this repository and follow the prompts
```console
cookiecutter gh:ladybug-tools/ladybug-tools-template
# Follow cookiecutter prompts
```
3. Because Github Actions and cookiecutter both use `{{` and `}}` to denote text that
should be replaced, you must go through the `ci.yaml` file after running cookiecutter
and manually replace all instances of `[[` with `{{` and `]]` with `}}`.
4. If you did not initialize the project on Github do so manually. Please visit https://github.com/new and create a repository for ladybug-tools/YOUR-PROJECT-SLUG (example: ladybug-tools/fire-ant for a project called Fire Ant). If you don't have the correct authorization to create repositories on the ladybug-tools organization then create a repo for your Github user and get in touch with the admins.
5. Add `GH_TOKEN`, `PYPI_USERNAME` and `PYPI_PASSWORD` to project secrets on GitHub.
The secrets are set in Ladybug Tools organization level.
The repository should be ready! Now go write some actual code!