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.9.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | d73acbc5267288406f05b5c48e6b64a19f7b4170634b2a6ece1e1556be617eb9 |
|
MD5 | 22b461c5b0aa0fdc40dfd526f6489bdd |
|
BLAKE2b-256 | 60ccba4ba0e4446bc076cc288f5380fc61a2081528299580faff27b7e4fa82f5 |
Hashes for escriptorium_connector-0.0.9-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 72b390cfd551053be226efc3cbd1f43410f30dff36e83879dbe447fbf5fb09a1 |
|
MD5 | ec692d17568b78a500a7f58e013609b0 |
|
BLAKE2b-256 | 4895fa18c3effd5b9cb5527df05eeb624c2f66102e5346a61082987207d03b7c |