samk13 / cookiecutter-invenio-rdm

Cookiecutter template for a new InvenioRDM instance.

Cookiecutter-Invenio-RDM

This Cookiecutter template is designed to help you to bootstrap an Invenio service.

Quickstart

Install the latest Cookiecutter if you haven't installed it yet:

pip install -U cookiecutter

Generate your Invenio RDM instance:

cookiecutter https://github.com/inveniosoftware/cookiecutter-invenio-rdm.git -c v1.0

More detailed steps can be found in the https://inveniosoftware.org/#getstarted

Features

• Python package: Python package for your service.
• Boilerplate files: README including important badges.
• License: MIT file and headers.
• ** TODO **

Configuration

To generate correct files, please provide the following input to Cookiecutter:

project_name	Full project name, might contain spaces.
project_shortname	Project shortname, no spaces allowed, use - as a separator.
project_site	Project website host.
package_name	Package/Module name for Python, must follow PEP 0008.
github_repo	GitHub repository of the project in form of USER/REPO, not the full GitHub URL.
site_code	Project code folder. Used for extending existing codebase.
**TODO**	**TODO**