Skip to main content

Package to connect to OKAPI API

Project description

OkapiPythonConnector

Some routines to connect OKAPI:Orbits software with python.

Dependencies:

  • python 3.8+
  • requests
  • python-dotenv

Installation walk-through

  1. Clone connector

git clone https://github.com/OKAPIOrbits/OkapiPythonConnector.git python-connector-git
cd python-connector-git

  1. Python environment

2.1 Linux/WSL

sudo apt install python3-pytest
sudo apt-get --assume-yes install python3.8 python3.8-dev python3-pip
python3.8 -m pip install python-dotenv

2.2 Windows

Install Python3.8 e.g. from Windows Store. Next, install required packages:

python3.8.exe -m pip install -r requirements.txt

  1. Running an example

See tryout.py for example calls. To get started create a .env file and add your username and password:

OKAPI_TEST_URL=https://api.okapiorbits.com/
OKAPI_TEST_USERNAME=your_username
OKAPI_TEST_PASSWORD=your_password

Make sure that the username and password itentifiers are identical to those used in the python script.

Execute script:

python3.8 -m pytest

Creating an account

Contact us at contact@okapiorbits.com

For more information, go to https://www.okapiorbits.space/documentation

Checkout the API at https://okapiorbits.space/api-redoc/

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

okapi-python-connector-2022.post9.tar.gz (8.7 kB view hashes)

Uploaded Source

Built Distribution

okapi_python_connector-2022.post9-py3-none-any.whl (17.2 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page