https://github.com/compas-dev/compas_package_template
Cookiecutter template for COMPAS extensions.
https://github.com/compas-dev/compas_package_template
cookiecutter python-package template
Last synced: 5 months ago
JSON representation
Cookiecutter template for COMPAS extensions.
- Host: GitHub
- URL: https://github.com/compas-dev/compas_package_template
- Owner: compas-dev
- License: mit
- Created: 2020-09-13T21:46:12.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-10-16T09:23:08.000Z (6 months ago)
- Last Synced: 2024-10-18T02:16:44.255Z (6 months ago)
- Topics: cookiecutter, python-package, template
- Language: Python
- Homepage:
- Size: 165 KB
- Stars: 6
- Watchers: 6
- Forks: 4
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# COMPAS package template
Cookiecutter template for COMPAS extensions.
[Cookiecutter](https://cookiecutter.readthedocs.io/en/latest/readme.html#)
is a command-line utility that lets you quickly bootstrap a new project from a template.
It takes a directory tree and copies it into your new project,
replacing all the generic info that finds surrounded by templating tags `{{` and `}}` with your project info written in `cookiecutter.json`.
## Features
* Project directory and file structure
* Documentation based on [Sphinx](http://www.sphinx-doc.org/en/master/)/[reStructuredText](http://docutils.sourceforge.net/rst.html)
* Testing framework: [pytest](https://docs.pytest.org/en/latest/)
* Basic setup script to create pip installable packages
* Automation of common tasks for development workflow based on [pyinvoke](http://www.pyinvoke.org/) (generate documentation, run tests, check format, etc.)
* [EditorConfig](https://editorconfig.org/) integration
* Minimal Github workflows for CI/CD
## What's included
* `.github`
* `data`
* `docs`
* `scripts`
* `src`
* `temp`
* `tests`
* `.editorconfig`
* `.gitignore`
* `CHANGELOG.md`
* `CONTRIBUTING.md`
* `LICENSE`
* `pyproject.toml`
* `README.md`
* `requirements-dev.txt`
* `requirements.txt`
* `tasks.py`
## Requirements
Install the `cookiecutter` command line utility: `pip install cookiecutter`.
## Usage
In the terminal, go to the folder where you want to place your project:
```bash
cd
```
Generate a new Cookiecutter template layout:
```bash
cookiecutter gh:compas-dev/compas_package_template
```
Go to project folder:
```bash
cd
```
Add the project files to the new `git` repo:
```bash
git add .
git commit -m "Initial commit"
```
## Additional settings
To use the coding style feature with [EditorConfig](https://editorconfig.org/):
Some text editors have a native EditorConfig.
If yours doesn't, you can download the appropriate plugin [here](https://editorconfig.org/#download).
## Github Actions
Basic CI/CD has already been setup in the .github folder, including automatic building and testing across systems, documentation generation etc.
### Automatic Publishing to PYPI
This requires adding your PYPI token in the repo or organization secrets as `PYPI`.
If you don't need this feature, go to [.github/workflows/release.yaml]({{cookiecutter.project_folder}}/.github/workflows/release.yml) and delete Lines 27~37.
## License
This template is licensed under the terms of the [MIT License](/LICENSE).