Skip to content

install_src_with_python.md

Latest commit

 

History

History
64 lines (40 loc) · 1.47 KB

install_src_with_python.md

File metadata and controls

64 lines (40 loc) · 1.47 KB

Run with Python

You will need:

  • Python
  • Pip

Install

Clone this repository, navigate to the root directory and install with pip:

pip3 install --editable .

Note: --editable is added so live code changes in the osvimdriver package are reflected in the next startup without the need for a re-install through pip.

Configuration

To customise the configuration of the driver, create a new k8s_config.yml in the directory you intend to run the driver from. Add the properties you desire to this file, below shows an example of some of the properties you may choose to set:

# Set the port the driver runs on
application:
  port: 8294

# Set the kafka address
messaging:
  connection_address: kafka:9092

This file will be found by the driver when it is started.

Start Development Server

The driver can be started with the simple command:

k8s-dev

Start Production Server

To run the application in production you will need a WSGI HTTP Server. We have tested and included instructions for both Gunicorn and uWSGI (2 of the recommended options from Flask):

Gunicon

Run the application by running the alm-gunicorn script:

k8svd-gunicorn

uWSGI

Run the application by running the ald-uwsgi script:

k8svd-uwsgi

Access Swagger UI

The Swagger UI can be found at http://your_host:8294/api/infrastructure/ui e.g. http://localhost:8294/api/infrastructure/ui