Skip to main content

This simple python package makes it easy to connect to an eScriptorium instance and to work with the data there.

Project description

[License: MIT]

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 credentials in a hidden .env file that does not get distributed with your code. This is pretty easy to accomplish with python-dotenv. You will need to provide the connector with an eScriptorium instance URL, the API URL, your username, and your password (see below).

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 = str(os.getenv('ESCRIPTORIUM_URL'))
    api = f'{url}api/'
    username = str(os.getenv('ESCRIPTORIUM_USERNAME'))
    password = str(os.getenv('ESCRIPTORIUM_PASSWORD'))
    escr = EscriptoriumConnector(url, api, username, password)
    print(escr.get_documents())

And your .env file should have:

ESCRIPTORIUM_URL=https://www.escriptorium.fr/
ESCRIPTORIUM_USERNAME=your escriptorium username
ESCRIPTORIUM_PASSWORD=your escriptorium password

See this Jupyter notebook for a longer introduction to the connector.

Development

Want to contribute? There is a lot to be done here, so we are happy for any PRs and updates.

Development Environment

This project uses Poetry. To start development, please pull down the repo from GitLab and run poetry install, which will make sure you have all the needed dependencies for the project and that you are using a valid Python version. Please use poetry add <your-pip-package> to install any new dependencies to the project so that they will be tracked by poetry.

Uploading to Pypi

Poetry also makes uploading to Pypi very easy. Just confirm that all the package details in pyproject.toml are correct, bump the version of the package poetry version 0.0.15, and then use poetry publish --build --username $PYPI_USERNAME --password $PYPI_PASSWORD, assuming you have set the environment variables $PYPI_USERNAME and $PYPI_PASSWORD appropriately (if you are using a Pypi token, then PYPI_USERNAME=__token__ and $PYPI_PASSWORD=<your-full-pypi-token>).

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

escriptorium-connector-0.0.17.tar.gz (8.9 kB view details)

Uploaded Source

Built Distribution

escriptorium_connector-0.0.17-py3-none-any.whl (8.6 kB view details)

Uploaded Python 3

File details

Details for the file escriptorium-connector-0.0.17.tar.gz.

File metadata

  • Download URL: escriptorium-connector-0.0.17.tar.gz
  • Upload date:
  • Size: 8.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.8 CPython/3.9.6 Linux/5.4.0-89-generic

File hashes

Hashes for escriptorium-connector-0.0.17.tar.gz
Algorithm Hash digest
SHA256 48b9011c24aaf98f1f016ee649a60d810ea4e9c7cdfd99a5f389993b53b58dda
MD5 acc5dfa4904d07b1d43e956567e60bf5
BLAKE2b-256 16799029fc0c76c46de6a3ffb5a51adfb0df53710d917aa2a3eabad1e7786df9

See more details on using hashes here.

File details

Details for the file escriptorium_connector-0.0.17-py3-none-any.whl.

File metadata

File hashes

Hashes for escriptorium_connector-0.0.17-py3-none-any.whl
Algorithm Hash digest
SHA256 aa39397fccb7a2f1d94d71dbf1ecab7880a4a57d99cb83f63ca462c48d0200b5
MD5 1acb7c5c350e629163c9b91bef28eb1c
BLAKE2b-256 67268e99d07eee11f61ec6740f09c56bf5616e568de740148a79f68861814415

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page