COMPAS package template

Cookiecutter template for COMPAS extensions.

Cookiecutter 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/reStructuredText
• Testing framework: pytest
• Basic setup script to create pip installable packages
• Automation of common tasks for development workflow based on pyinvoke (generate documentation, run tests, check format, etc.)
• EditorConfig integration
• Minimal Github workflows for CI/CD

What's included

• .github
• data
• docs
• scripts
• src
• temp
• tests
• .bumpversion.cfg
• .editorconfig
• .gitignore
• AUTHORS.md
• CHANGELOG.md
• conftest.py
• CONTRIBUTING.md
• LICENSE
• MANIFEST.in
• README.md
• requirements-dev.txt
• requirements.txt
• setup.cfg
• setup.py
• 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:

cd <your-projects-folder>

Generate a new Cookiecutter template layout:

cookiecutter gh:compas-dev/compas_package_template

Go to project folder:

cd <project-slug>

Add the project files to the new git repo:

git add .
git commit -m "Initial commit"

Additional settings

To use the coding style feature with EditorConfig:

Some text editors have a native EditorConfig. If yours doesn't, you can download the appropriate plugin here.

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 and delete Lines 27~37.

License

This template is licensed under the terms of the MIT License.