Unmand Python SDK
This is a simple package to aid in consuming the Unmand APIs.
For more help, see our docs.
Getting Started
Create virtual environment
$ python3 -m venv venv
Start virtual environment
$ source venv/bin/activate
Install python requirements
$ pip install -r requirements.txt
Install Wheel for GemFury management
$ pip install wheel
If you need to create a new package
Run the following command after updating setup.py version
$ python setup.py bdist_wheel
and then drag and drop the new package generated file inside the dist folder
Example Usage
from unmand import Job, ExfilAPI
token = 'TOP-SECRET-EXAMPLE-TOKEN'
document_path = 'Sample.pdf'
exfil = ExfilAPI(token)
with open(document_path, 'rb') as file_data:
job = exfil.queue(file_data)
print(job)
if job.status != "FAILED":
exfil.poll(job=job)
if job.status == 'FINISHED':
print(job.result)
ExfilAPI and Job
The main class is ExfilAPI. Instantiate this with your token argument. Use the optional argument test to direct your queries to the test API instead of the production API. For example:
exfil_test = ExfilAPI(token, test=True) # This aims at the test API
exfil = ExfilAPI(token) # This aims at the production API
Submit a job by attaching the binary file data from your system to the queue method of ExfilAPI. This will return an instance of the Job class.
job = exfil.queue(file_data)
At any time, you can get the status of the job:
print(job) # or
print(job.status)
Once a job is queued, call the poll method of the ExfilAPI class to be updated when the job is finished. Use the optional argument suppress_output to stop updates printing to screen.
exfil.poll(job=job) # or
exfil.poll(job=job, suppress_output=True)
Once finished, the results of the job are saved as a dictionary under the result attribute.
print(job.result)
Swarm Tasks
There is a SwarmAPI class so that swarm tasks can be uploaded for display in the UI. An example usage is shown below. Be careful, the token for a Swarm project will be different.
swarm = SwarmAPI(token, test=True)
start_time = datetime.utcnow()
finish_time = datetime.utcnow()
response_details = {'Some data': 1, 'Some other data': 2, "an array": [1,2,3,4]}
status = 'SUCCESS' # or 'FAILURE'
task = Task('UniqueTestId', start_time, finish_time , status, 'PROD', 'Short Response', response_details , "First Identifier", "Second Identifier", "Third Identifier")
swarm.upload_swarm_task(task)
1.7k Jan 3, 2023
224 Jan 4, 2023
455 Dec 24, 2022
4.1k Jan 4, 2023
5.4k Feb 20, 2021
4.3k Jan 2, 2023
1.9k Dec 29, 2022
64 Sep 28, 2022
55 Dec 26, 2022
22 Jan 03, 2023
306 Jan 03, 2023
5 Jan 18, 2022
7 May 22, 2022
69 Dec 23, 2022
1 Nov 14, 2021
1 Nov 07, 2021
2 Jun 24, 2022
2 Mar 07, 2022
2 Dec 10, 2021
12 Oct 25, 2022
50 Jan 06, 2023
1 Nov 21, 2021
1 Oct 25, 2021
4 Dec 06, 2022
6 Nov 10, 2021
35 Jan 02, 2023
1 Jan 19, 2022
2 Dec 06, 2021
1 Nov 22, 2021