https://github.com/quansight/cookiecutter-basic-conda
Cookiecutter for creating a basic conda package
https://github.com/quansight/cookiecutter-basic-conda
Last synced: about 1 year ago
JSON representation
Cookiecutter for creating a basic conda package
- Host: GitHub
- URL: https://github.com/quansight/cookiecutter-basic-conda
- Owner: Quansight
- License: bsd-2-clause
- Created: 2021-04-29T14:59:11.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2021-04-29T15:11:54.000Z (about 5 years ago)
- Last Synced: 2025-06-19T00:40:51.011Z (about 1 year ago)
- Language: Python
- Size: 8.79 KB
- Stars: 1
- Watchers: 39
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Basic Conda Package Cookiecutter
A cookiecutter to generate a very basic conda package including framework for cli, a conda recipe, and auto-release using rever.
## Quickstart
Install the latest Cookiecutter if you haven't installed it yet (this requires Cookiecutter 1.4.0 or higher):
```
pip install -U cookiecutter
```
Generate a Python package project:
```
cookiecutter https://github.com/Quansight/cookiecutter-basic-conda.git
```
## Features
* Testing setup
* Release automation with [rever](https://regro.github.io/rever-docs/)
* Conda recipe structure setup
* Command line interface using Click (optional)
## Directory structure
This cookiecutter package generates the following directory structure:
```
├── .gitignore <- file types for git to ignore
├── CHANGELOG.rst <- changelog for release, auto-filled by rever
├── LICENSE <- license file
├── README.md <- top-level README for developers using this project.
├── rever.xsh <- rever config
├── setup.cfg <- setup config
├── setup.py <- makes this project pip installable with `pip install -e`
│
├── conda.recipe
│ └── meta.yaml <- environment requirements for the conda recipe
│
├── news
│ └── TEMPLATE.rst <- template for the changelog to be autofilled by rever
│
├── package_name
│ ├── __init__.py <- makes package_name a Python module
│ ├── __main__.py <- framework for cli
│ └── cli.py <- framework for cli
│
└── tests
├── __init__.py <- makes tests a Python module
└── test_cli.py <- basic cli test
```