snakeframe

A cookiecutter template for accessible, reproducible Python packages

TL;DR

All you need is cookiecutter.

cookiecutter gh:oasci/snakeframe

Features

In this cookiecutter 🍪 template we combine state-of-the-art libraries and best development practices for Python.

Development

• Supports Python 3.10 and higher.
• Seamless conda + pip dependencies manager with pixi.
• Automatic codestyle with ruff and isort.
• Type checks with mypy.
• Testing with pytest.
• Ready-to-use .editorconfig and .gitignore.

Deployment

• Github Actions or GitLab pipelines.
• Code style checks, code formatting, testing, linting, etc. already setup with pixi tasks.
• Sphinx or MkDocs documentation.

Community

• Pull Request and several Issue templates.
• Files such as: LICENSE and CODE_OF_CONDUCT.md are generated automatically.

License

Code contained in this project is released under the MIT License as specified in LICENSE.md. This license grants you the freedom to use, modify, and distribute it as long as you include the original copyright notice contained in LICENSE.md and the following disclaimer.

Portions of this code were incorporated and adapted with permission from snakeframe by OASCI under the MIT License.