This Cookiecutter template is designed to help you to bootstrap an Invenio service.
Install the latest Cookiecutter if you haven't installed it yet:
pip install -U cookiecutter
Generate your Invenio instance:
cookiecutter https://github.com/inveniosoftware/cookiecutter-invenio-instance.git -c v3.1
More detailed steps can be found in the https://invenio.readthedocs.io/en/latest/quickstart/quickstart.html
- Python package: Python package for your service.
- Boilerplate files: README including important badges, AUTHORS and CHANGES files.
- License: MIT file and headers.
- Installation: Installation workflow and dependency management using pipenv.
- Tests: Testing setup using pytest.
- Documentation: Documentation generator using Sphinx. Also includes all files required for Read the Docs. Mocking module to simulate not-installed requirements for faster documentation building.
- Continuous integration: Support for Travis which tests all requirement levels and adds coverage tests using Coveralls.
- Your toolchain: Ignores a decent set of files when working with Git and Docker. Gets your editor to adapt project guidelines by providing an EditorConfig file.
To generate correct files, please provide the following input to Cookiecutter:
project_name |
|
project_shortname |
|
project_site |
|
package_name |
|
github_repo |
|
description |
|
author_name |
|
author_email |
|
year |
|
copyright_holder |
|
transifex_project |
|
database |
|
elasticsearch |
|
datamodel |
|
datamodel_extension_class |
|
datamodel_pid_name |
|
Further documentation is available on https://invenio.readthedocs.io/