scribemi 1.1.1

Library to manage MI files in Scribe's platform

Scribe MI

Python library to manage MI files in Scribe's platform

---

This library allows the management of MI (Monitoring Information) in a simple way.

You first need a Scribe account, an id_token and an api_key. The account and the api_key can both be requested at contact[atsign]scribelabs[dotsign]ai, and the id_token can be generated by the user.

One way to generate the id_token is through ScribeAuth library. The function get_tokens will return a Dictionary with three different tokens and it is necessary to extract the correct one to make it work (id_token).

It is important to use the function update_id_token before calling any other method of this library to avoid exceptions. If the id_token has expired, it will be necessary to update it again.

---

This library requires a version of Python 3 that supports typings.

Installation

pip install ScribeMi

1. Update id token to gain access

from ScribeMi import MI
mi = MI('api_key', 'url')
mi.update_id_token('idtoken')

2. List uploaded archives

from ScribeMi import MI
mi = MI('api_key', 'url')
archives = mi.list_archives()

3. Upload archive with file path

from ScribeMi import MI
mi = MI('api_key', 'url')
archive_name = mi.upload_archive('file_name')

4. Upload archive with file in memory

from ScribeMi import MI
mi = MI('api_key', 'url')
with open('file_name', 'rb') as f:
	archive_name = mi.upload_archive(f)

5. Delete archive by file_name

from ScribeMi import MI
mi = MI('api_key', 'url')
deleted = mi.delete_archive('file_name')

6. Get job by jobid

from ScribeMi import MI
mi = MI('api_key', 'url')
job = mi.get_job('jobid')

7. Upload job with file path (file_name is optional)

from ScribeMi import MI
mi = MI('api_key', 'url')
job_created = mi.create_job('company_name', 'file_path', 'filetype', 'file_name')

8. Upload job with file in memory (file_name is optional)

from ScribeMi import MI
mi = MI('api_key', 'url')
with open('file_path', 'rb') as f:
	job_created = mi.create_job('company_name', f, 'filetype', 'file_name')

9. Delete job by jobid

from ScribeMi import MI
mi = MI('api_key', 'url')
deleted = mi.delete_job('jobid')

---

To flag an issue, open a ticket on Github.