Trovi

Trovi is a platform for sharing and reproducing research artifacts. It provides a REST API for use by various clients.

Documentation

Read our documentation on GitBook!

Development

Trovi is a Django application built on Django REST Framework which is designed to run in a Docker container. Trovi is written in Python 3.9. Developing for Trovi requires little setup.

Building the development image

$ make build-dev

You can also build and run Trovi using docker-compose with the appropriate environment variables. To see environment variables used for configuration, check out the sample environment.

Running tests

Trovi runs a number of smoke tests based on the built-in Django test runner. To run tests, you can run

$ make test

or, you can run it manually using the docker-compose file specifically intended for testing.

Publishing

Publish a new production image for Trovi using its git hash as the tag:

$ make publish

Tag the latest local image of Trovi as latest and publish it:

$ make publish-latest