polyanalyst6api is a PolyAnalyst API client for Python.
Project description
polyanalyst6api
polyanalyst6api
is a python package for accessing PolyAnalyst's APIs.
Installation
The easiest way to install polyanalyst6api-python
is from PyPI:
$ pip install polyanalyst6api
You may also use Git to clone the repository from GitHub and install it manually:
git clone https://github.com/Megaputer/polyanalyst6api-python.git
cd polyanalyst6api-python
pip install poetry
poetry install
Usage
See API Reference for more detailed information.
Authentication
Import client, initialize it and log in to PolyAnalyst's server:
import polyanalyst6api as polyanalyst
api = polyanalyst.API(POLYANALIST_URL, USERNAME, PASSWORD)
api.login()
API
supports Context Manager protocol, so you could use it with with
statement. In this case API
will automatically log in with provided credentials.
with polyanalyst.API(POLYANALIST_URL, USERNAME, PASSWORD) as api:
pass
Working with project
See polyanalyst6api-python/examples for a more complex examples.
At first you need to connect to existing project:
prj = api.project(PROJECT_UUID)
Print node names within project:
for node_name in prj.get_nodes():
print(node_name)
Initiate node execution:
prj.execute(NODE_NAME)
Display the preview of node results:
result = prj.preview(NODE_NAME)
print(result)
Save project:
prj.save()
PolyAnalyst API
Full API specification is stored in the PolyAnalyst User Manual under the url below:
/polyanalyst/help/eng/24_Application_Programming_Interfaces/toc.html
Supported Python version
polyanalyst6api-python
works only with python3
(3.4+).
License
This project is licensed under the MIT License - see the LICENSE.md file for details
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
Hashes for polyanalyst6api-0.9.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 01f279ec159a66c668291ad4b67f012f8c66957253aae3885e46f0119f08ef09 |
|
MD5 | 56fc1645f624df62a015e8842bdf7072 |
|
BLAKE2b-256 | 248ebc77ab75ceadca50817685058d64b8669fda61f2d902066da5bf9bb63c4a |