A wrapper for the Intellinget Plant API
Project description
Python App Store API Client
A python implmentation of the Intelligent Plant industrial appstore API client
See the example folder for example on how to use the library for authorization code and implicit OAuth grant flows.
Getting started
Installing using pip
pip install intelligent-plant
Installing from Source
Using pip:
pip install git+https://github.com/intelligentplant/py-app-store-api
Alternatively clone the Git repo:
git clone https://github.com/intelligentplant/py-app-store-api.git
Example Scripts
The 'example' folder contains a series of examples which demonstrate the available authentication methods and queries that you can make using this library.
To install dependencies used by the example scripts run
pip install -r example-requirements.txt
Querying the Industrial App Store
In order to query the industrial app store you must register as a developer and create an app registration. Full instructions can be found here: https://wiki.intelligentplant.com/doku.php?id=dev:app_store_developers
Once you have created and app registration you will need to copy and rename config-example.json
to config.json
and populate the id
and secret
fields with you app ID and app secret.
To run the authorization code grant flow example run:
python example\authorization_code_grant_flow.py
To run the authorization code grant flow example with the PKCE extensionrun:
python example\authorization_code_grant_flow_pkce.py
To run the implicit grant flow example run:
The implicit grant flow is deprecated and is disabled by default
python example\implicit_grant_flow.py
Querying a local App Store Connect or Data Core node
To run the NTLM (windows authentication) example you will need to have a data core node available on the local network.
If you have an App Store Connect (https://appstore.intelligentplant.com/Home/DataSources) installed locally you can run the example without modification. If you are trying to authenticate with a data core node you will need to change the base_url
variable defined in the script to match the URL of the Data Core admin UI.
Run the example using:
python example\ntlm_example.py
Example Notebooks
You can find examples of how to use the library to make queries in our Jupyer Hub demo notebooks (these notebooks expect a valid Industrial App Store access token to be present in the ACCESS_TOKEN
environment variable).
https://github.com/intelligentplant/jupyter-hub-demo/tree/master/Python
To use this library as part of a Jupyter Notebook join the Jupyter Hub:
https://appstore.intelligentplant.com/Home/AppProfile?appId=40d7a49722f84be4986318bb5cc98cf3
Project details
Release history Release notifications | RSS feed
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
File details
Details for the file intelligent_plant-1.6.2.tar.gz
.
File metadata
- Download URL: intelligent_plant-1.6.2.tar.gz
- Upload date:
- Size: 13.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.10.4
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0282a8927cf0e52561a4c9dabf7b964f5f30f84efd76eff3b5afe2f16cd1e16a |
|
MD5 | 8440dce60d16a4fab16c04c457b53473 |
|
BLAKE2b-256 | 80225d97c151eda1232fa4ae186297362f4fb18d5f551560d9f625ac9536fc98 |
File details
Details for the file intelligent_plant-1.6.2-py3-none-any.whl
.
File metadata
- Download URL: intelligent_plant-1.6.2-py3-none-any.whl
- Upload date:
- Size: 14.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.10.4
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2c739dc64dce5b40e439e782747a19612b75a51aac756b88e1b24dcd3b7d33bb |
|
MD5 | 077eb9b06d7345a4b76054f83f7c21f2 |
|
BLAKE2b-256 | 219d4ff55635826335af30076c8d386fff9c5481e692b9c55519f82cbd5d18d5 |