Installation

Installation from PIP Package

The built package of CAM2 Camera Database API Client is uploaded in Pypi. You can check Pypi page of the package for specific environment requirements.

To install CAM2 Camera Database API Client, simply run the following command to install the latest version:

$ pip install CAM2CameraDatabaseClient

To install a specific version, run command:

$ pip install CAM2CameraDatabaseClient==<desired_version_number>

Installation from Python Source

Source code of CAM2 Camera Database API Client is public on GitHub. You can always install the package from source code by either downloading the zip file or clone the repository with command:

$ git clone git@github.com:PurdueCAM2Project/CameraDatabaseClient.git

You can add the downloaded source code in your own python package and use CAM2 Camera Database API Client modules by importing them.

Warning

We are continuously developing the Python client and updating the code. Downloading or cloning the source code will not guarantee you will a stable software to use.

Insallation for Developers

The CameraDatabaseAPIClient uses Docker which proivdes developers a sandbox enviroment using containers to easily create, deploy, and run projects on any operating system. You can follow the steps on the Docker website to download and install Docker on your machine.

Setting up a project using Docker requires two main files, the docker-compose.yml and the Dockerfile. The docker-compose.yml file contains the initilizations of the containers. In our case, we use two contatiners, one for running the test cases and one for running the pylint error checking. The Dockerfile contains all the images needed to run the testing commands. For example, we retrieve the Python 3.6 and 2.7 images to run the tests in both versions of Python that we support. Then, we run the commands needed to install the requirements and dependencies of the project, and lastly run the test cases.

After setting up Docker, you can run Docker on your project by running the Setup bash file which contains all the Docker commands needed to run Docker:

$ sh Setup.sh

Docker will now run and retrieve the images needed from the web to run the test cases.