Skip to content

inveniosoftware/cookiecutter-invenio-ils

Repository files navigation

Cookiecutter-Invenio-ILS

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

Quickstart

Install the InvenioCLI tool if you haven't installed it yet:

pip install -U invenio-cli

Generate your Invenio ILS instance:

invenio-cli init ils -c v4.0.0

More detailed steps can be found in the https://invenioils.docs.cern.ch/reference/scaffold/#initialize-project

Next Steps

Once you have generated the project, you can check the README.md file inside the <project_shortname> directory for further steps on how to setup and run the project!

Features

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

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.
github_repo GitHub repository of the project in form of USER/REPO, not the full GitHub URL.

About

Cookiecutter template for a new InvenioILS instance.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •