pyreslib 0.1.0

Python package for digital libraries from the Resounding Libraries cluster at Orpheus Instituut

py-resounding-libraries

Python package for digital libraries from the Resounding Libraries cluster at Orpheus Instituut.

Documentation

Package documentation available via GitHub Pages.

Installation and Setup

Setting up virtual enviroment

Generate the virtual enviroment on your project folder:

# Generate local python binaries in folder
python3 -m venv rl-env

Activate virtual enviroment in order to invoke the package:

# activate the enviroment for this terminal
source $rl-env/bin/activate

Installation via pip

pip install pyreslib

Dependencies listed in requirements.txt.

Setting up Credentials

After cloning this repository, you should create a credentials folder to store all your sensible data. All credentials are stored in credentials.json file in this form:

{
	"koha": {
		"oauth_credentials": {
    	"description": "username",
    	"client_id": "clientid generated by Koha",
    	"secret_key": "secret key generated by Koha"
		},
	"basic_credentials": {
    	"user": "[e-mail]",
    	"password": "password"
		}

	},
	"resourcespace": {
		"rs_api_url": "https://your.rs.domain/api/v1/",
		"secret_key": "secret key" 
	},

	"orcid": {
    "client_id": "xxx",
    "client_secret": "yyyy",
    "redirect_uri": "https://example.org"
}
}

Modules

Koha

This module collects a series of Python scripts, build upon pyMARC and the Koha REST API, to allow batch operation for your library catalogue and enriching metadata scripts with external linked open data information from Wikidata.

ResourceSpace

Resourcespace is an open source digital assets management system.

In the module resourcespace you can find some useful Python scripts to dynamically interact with your Resourcespace instance. Metadata for each record are pulled through Koha and ingested to Resource Space fields, collections and resources.

Transkribus

...

Research Output

...

Omeka S

NOTE: Still in development.

ORCiD

ORCID is a non-profit organization that provides a persistent digital identifier (an ORCID iD) that distinguishes you from every other researcher. Since 2023, Orpheus Instituut registers the research output of its members through the Koha catalogue. Each research output is stored as record and a plugin has been developed to batch export the data to FRIS.

In the module orcid you can find some useful Python scripts, build upon pyOrcidto dynamically interact with your ORCID instance.

NOTE: Still in development...