Omni API
Simple REST API wrapper for the Omni infra-structure.
Configuration
| Name | Type | Description |
|---|---|---|
| OMNI_BASE_URL | str |
The base URL that is going to be used for API connections (defaults to http://localhost:8080/mvc/). |
| OMNI_OPEN_URL | str |
The open URL for the Omni connection (defaults to OMNI_BASE_URL). |
| OMNI_PREFIX | str |
The default prefix to be used for API requests (defaults to adm/). |
| OMNI_ID | str |
The client id to be used for API connections (defaults to None). |
| OMNI_SECRET | str |
The secret key to be used for API connections (defaults to None). |
| OMNI_REDIRECT_URL | str |
The URL to be used for redirection OAuth based workflow (defaults to base,base.user,base.admin,foundation.store.list). |
| OMNI_USERNAME | str |
The username to be used on direct workflow (defaults to None). |
| OMNI_PASSWORD | str |
The password to be used on direct workflow (defaults to None). |
Usage
Typical usage of the Omni client implies the providing of the username and the password inside the target omni instance (Direct Mode).
api = omni.Api(
base_url = "http://frontdoorhq.com",
username = "YOUR_USERNAME",
password = "YOUR_PASSWORD"
)
Alternatively it's possible to use the api throught an OAuth base approach using the provided client id and secret values.
api = omni.Api(
base_url = "http://frontdoorhq.com",
client_id = "YOUR_OAUTH_ID",
client_secret = "YOUR_OAUTH_SECRET"
)
For these type of handling the OAuthAccessError exception must be handled and then
the user must be redirect to the url provided by api.oauth_autorize method call.
Running then the api.oauth_access call with the returned code from the server side
that should be used to redeem the access_token required for session authentication.
Examples
Examples are located here.
Testing
The unit test suite runs using pytest and requires Python 3.10+, unlike the library itself the tests make full use of the provided type stubs (the library implementation remains Python 2.7+ compatible).
pip install pytest
pytest
The live integration tests run against a local Omni instance and are skipped unless the OMNI_TEST_LIVE environment variable is set, together with the usual OMNI_BASE_URL, OMNI_USERNAME and OMNI_PASSWORD configuration.
Such an instance can be provisioned with demo data using the hivesolutions/omni docker image (private, registry credentials required), the loader seeds the database with the demo dataset (including the root / Root@12345 credentials) and the server is then started, note that with COLONY_PREFIX=/mvc the client base URL should not include the /mvc prefix:
docker run -d --name omni -p 8080:8080 --entrypoint sh \
-e RUN_MODE=development \
-e COLONY_CONFIG_FILE=config/python/singleton.py \
-e DB_ENGINE=sqlite \
-e DB_FILE=ci.db \
-e RESET_DB=1 \
-e AT_TEST_MODE=1 \
hivesolutions/omni:latest \
-c "cd /omni && python3 scripts/load_demo_data.py && exec colony_wsgi"
OMNI_TEST_LIVE=1 OMNI_BASE_URL=http://localhost:8080/ OMNI_USERNAME=root OMNI_PASSWORD=Root@12345 pytest
The CI pipeline runs the same provisioning in the Build Live job whenever the Docker Hub credentials are available as repository secrets (DOCKERHUB_USERNAME and DOCKERHUB_TOKEN), skipping the live run otherwise.
Type checking of the stubs, examples and tests is done using Pyright:
pip install pyright
pyright src/omni/*.pyi src/examples src/omni/test
License
Omni API is currently licensed under the Apache License, Version 2.0.
Build Automation
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file omni_api-0.10.1.tar.gz.
File metadata
- Download URL: omni_api-0.10.1.tar.gz
- Upload date:
- Size: 31.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
3a923cfc5d4a98054d29c7cc0a095ff4c55596a63189b7073212bef20e050a20
|
|
| MD5 |
91ec26186321973e136ff4215048ed78
|
|
| BLAKE2b-256 |
37a03c31ff6566eaff78e84a3d00ef7f86af122418756777623066ab15f8016a
|
File details
Details for the file omni_api-0.10.1-py2.py3-none-any.whl.
File metadata
- Download URL: omni_api-0.10.1-py2.py3-none-any.whl
- Upload date:
- Size: 81.9 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
e80e8c0020b467845d45367bb1ceee44576c0b19d3b76e94cec3f15ab92e1459
|
|
| MD5 |
74582a680014a8e6bfa9e2ca7e212cc5
|
|
| BLAKE2b-256 |
8b6a18740bc003b7cf9f66206ff04dd9b39a3d5efc86c342e0aa890a2867920f
|
