Skip to content

A Cookiecutter repository template for an open-source project.

License

Notifications You must be signed in to change notification settings

mim-solutions/repository-template

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Repository Template

This repository contains a cookiecutter template for creating an open-source project.

To use it, first install the cookiecutter command:

pip install cookiecutter

Example usage (will open dialogue and create a new directory in the current directory, based on passed project name):

cookiecutter git@github.com:mim-solutions/repository-template.git --directory your_project

You can first clone the new repository for a new project and pass the extra -f argument to overwrite contents of the cloned repository by cookiecutter.

More details on cookiecutter at https://cookiecutter.readthedocs.io/.

Development

To test a template during development, with this repository cloned locally, pass a path as in the example:

cookiecutter /path/to/this/repo