This simple python package makes it easy to connect to an eScriptorium instance and to work with the data there.
Project description
[]
Escriptorium Connector
This simple python package makes it easy to connect to escriptorium and work with the data stored there.
Installation
And the obligatory: pip install escriptorium-connector
Usage
If you are working on a public repository, you will probably want to store your user token in a hidden .env
file that does not get distributed with your code. This is pretty easy to accomplish with python-dotenv. You can get your user token by going to your eScriptorium instance (perhaps https://escriptorium.fr/), logging in, clicking on your username then "profile", and selecting "Api key". The token is a fairly long string of random letters and numbers.
The EscriptoriumConnector
class provides (or will provide) all the methods needed to interact programmatically with the eScriptorium platform.
Example usage:
from escriptorium_connector import EscriptoriumConnector
import os
from dotenv import load_dotenv
if __name__ == '__main__':
load_dotenv()
url = os.getenv('ESCRIPTORIUM_URL')
api = f'{url}api/'
token = os.getenv('ESCRIPTORIUM_TOKEN')
escr = EscriptoriumConnector(url, api, token)
print(escr.get_documents())
And your .env
file should have:
ESCRIPTORIUM_URL=https://www.escriptorium.fr/
ESCRIPTORIUM_TOKEN='your secret user token here'
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 escriptorium-connector-0.0.7.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 805bfd3336b7690ddfea9ae521125d8fbccc8f7cfae066d3f38594f4dd7f493c |
|
MD5 | 27a34a925272509673970f8b1e5eaeff |
|
BLAKE2b-256 | cb926046ee577b9b16547a0d461ea69b7b956f78816e6596162bd34943a7002a |
Hashes for escriptorium_connector-0.0.7-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4dc2d720c2b2789a59558507c3a30398c622257bc26a486c3bb1ac770d840b9b |
|
MD5 | d292cda684bad9df99f0d169c2ee1769 |
|
BLAKE2b-256 | ef988807f5e85884823c80db8150eadf5761503a19952e98a4d33c20712cdd94 |