A convenience connector to the eScriptorium platform
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.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4a360d79798228ff66bcbf93e9a521fb220c38d88d4735ddd0d87d6bc608e7f8 |
|
MD5 | 07cd1663da1291221a34e468dfe2327a |
|
BLAKE2b-256 | 2005ba74ff0d901e95f2f21126204877068d578f84ad970acebfa276766f3b43 |
Hashes for escriptorium_connector-0.0.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | fad23d815482a537503cb3b8aa089cd63e44e1278ce59f3b54cd9161df6ef3aa |
|
MD5 | 054a20c3f62da9cb34493071771c95eb |
|
BLAKE2b-256 | eef5d36b33772c60fecaa5e661435a89f7db5547ae4cb6ab0f855a4c71049853 |