Pipfile lists all Python dependencies of reuse-api, and
Pipfile.lock contains information about the actual versions of these
dependencies recommended for use. You can use
pipenv install --system to
download and install all these dependencies on your computer.
Please note that reuse-api requires SSH access to a REUSE lint server.
./setup.py install in the git checkout directory to install reuse-api
on the local machine. There are a number of options to select the installation
target, for example installing with a specific prefix, or installing in a home
directory to be able to install without root permissions. Run
install --help for more information. Run
./setup.py --help-commands for a
list of other tasks you can do with
Dockerfile contains build instructions for a Docker container in which
reuse-api can run. After installing the requirements, it installs reuse-api
setup.py install, all as described in the previous sections.
Within the Docker container, reuse-api runs as non-privilleged user “fsfe” for security reasons.
reuse-api uses drone to automatically deploy updates to the production server.
Upon each push to the master branch of the git repository, drone creates a
temporary clone of the repository and then sequentially executes the following
steps defined in
quality: in a container with the previously created image, run a number of quality checks to ensure no obviously broken code is deployed to the production server.
deploy: again, use
docker-compose, this time to create the actual
docker image and start the corresponding container. The file
docker-compose.yml defines the parameters for this step, referring to
Dockerfile described in the previous section.