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.6.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | d5cba74fec790dae0ba9f232815f4a77d71c2c7d841d7774fd1b34bfc12db2c9 |
|
MD5 | 22175a96675885eb031e31623bb7c2e4 |
|
BLAKE2b-256 | 801ae85cadb2bbac236586dae4683087f146f45e28fdc0e3f81faf70eb4ed2b4 |
Hashes for escriptorium_connector-0.0.6-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 43bf20363de00be8f3c79d65d78c7e9d777ef5fb04ad6474dd1d4e7f66d1df40 |
|
MD5 | 8f89bb45356ab0212220d22bc71e6f49 |
|
BLAKE2b-256 | 6439928b62a14f5b619f478b369a3ccf916990e257fe75c703ea4dba9b0133bf |