README.md

inquire-modeltest-sdk

About

Python software developer kit (SDK) for the Sevan modeltest API

Status

Get started

Install the SDK from Sevan's private package index by

pip install modeltestSDK --extra-index-url https://api.packagr.app/EYvhW6SyL/

Visit the documentation to learn how to use it.

Contribute

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

Install Python version 3.9 or 3.10 from either https://www.python.org or https://www.anaconda.com.

We use Poetry for dependency management and packaging. Install it as shown here.

Clone the source code repository

At the desired location, run:

git clone https://github.com/SevanSSP/inquire-modeltest-sdk.git

Set up the Python environment

At the project root, run

poetry install

... to create a virtual environement and install the dependencies.

Now you are ready to code!

Testing

To run all tests

pytest tests

or

nox -s tests

Local functional testing requires that the model test API is running at http://127.0.0.1:8000 (local host)

Versioning

This project uses semantic versioning. More info

License

This project is licensed under the MIT License - see the LICENSE file for details.

Authors

• Jørgen Engelsen - joreng2607
• Per Voie - tovop
• Snorre Fjellvang - tovop
• Einar Glomnes - EBGlom