cdslab_cmodels_api

cmodels API repo

Setup

Make sure you have already installed the required python version (see Pipfile)

For pipenv users

1. Clone this repository

   $ git clone https://github.com/fenfisdi/cdslab_cmodels_api
   $ cd cdslab_cmodels_api

2. Install pipenv

   $ pip3 install pipenv

3. Create virtual environment, and install packages (including developer packages) within the environment

   $ pipenv install --dev

4. Start virtual environment session

   $ pipenv shell

   NOTE: if you want to close the session just execute $ exit

5. Create your ~/cdslab_cmodels_api/.env file with appropiate HOST and PORT variables defined.

6. Run the uvicorn server via the ~/cdslab_cmodels_api/main.py file

   $ python model.py

7. Enjoy...

For non-pipenv users

We will try to keep the requirements.txt file up to date. However, if you find out that some dependencies were not installed, we recommend updating this file via the following command:

$ pipenv lock --dev -r > requirements.txt

You can now configure the virtual environment using your preferred framework.

Note: before updating the requirements.txt file make sure you have already installed pipenv via $ pip install pipenv or by any other means.