invenio-circulation.md

Invenio-circulation

invenio-circulation is a module used in RERO-ils to manage item loans.

RERO have a specific repository to develop and enhance invenio-circulation module. You can find documentation on RERO circulation module.

Install and test

You first need invenio-circulation branch from Github. Choose among one of:

• [email protected]:inveniosoftware/invenio-circulation.git (official)
• [email protected]:rero/invenio-circulation.git (ours)

git clone [email protected]:rero/invenio-circulation.git
cd invenio-circulation

Then install all needed dependencies (in invenio-circulation directory):

pipenv run pip install -r requirements-devel.txt
pipenv run pip install -e .[all,elasticsearch6,postgresql]

Check that your RERO-ils docker containers are launched (in rero-ils directory):

cd ../rero-ils
docker-compose up -d && ./docker/wait-for-services.sh

Finally you can launch invenio-circulation module tests like this (in invenio-circulation directory):

cd ../invenio-circulation
pipenv run python setup.py test

Developing with rero-ils and invenio-circulation

In rero-ils directory ([email protected]:rero/rero-ils.git repository), you need to change pyproject.toml. Especially this line:

invenio-circulation = {tag = "v1.0.0a23", git = "https://github.com/inveniosoftware/invenio-circulation.git"}

• tag could be a branch name
• git should be changed by your repository path on Github (or elsewhere)

Then do:

poetry update invenio-circulation

This will install your repository from your github fork of invenio-circulation.