pyreslib 0.1.0__tar.gz

pyreslib-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 NicholasCorniaOrpheus
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

pyreslib-0.1.0/PKG-INFO

@@ -0,0 +1,135 @@
+Metadata-Version: 2.4
+Name: pyreslib
+Version: 0.1.0
+Summary: Python package for digital libraries from the Resounding Libraries cluster at Orpheus Instituut
+Author-email: Nicholas Cornia <nicholas.cornia@orpheusinstituut.be>
+License-Expression: MIT
+Project-URL: Homepage, https://nicholascorniaorpheus.github.io/py-resounding-libraries/
+Project-URL: Repository, https://github.com/NicholasCorniaOrpheus/py-resounding-libraries
+Keywords: koha,wikidata,digital-libraries,transkribus,omekas,bibtex,marc,library-software
+Classifier: Development Status :: 4 - Beta
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: bibtexparser>=1.4.4
+Requires-Dist: omeka-s-tools>=0.3.0
+Requires-Dist: pandas>=2.3.3
+Requires-Dist: pymarc>=5.3.1
+Requires-Dist: pyyaml>=6.0.3
+Requires-Dist: requests>=2.33.1
+Requires-Dist: requests-oauth2client>=1.8.0
+Requires-Dist: sparqlwrapper>=2.0.0
+Requires-Dist: urllib3>=2.6.3
+Requires-Dist: wikibaseintegrator>=0.12.15
+Provides-Extra: docs
+Requires-Dist: mkdocs>=1.6.1; extra == "docs"
+Requires-Dist: mkdocs-material>=9.7.6; extra == "docs"
+Requires-Dist: mkdocstrings[python]>=1.0.4; extra == "docs"
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Requires-Dist: black>=22.0; extra == "dev"
+Requires-Dist: ruff>=0.1; extra == "dev"
+Dynamic: license-file
+
+# py-resounding-libraries
+Python package for digital libraries from the Resounding Libraries cluster at Orpheus Instituut.
+
+## Documentation
+
+[Package documentation](https://nicholascorniaorpheus.github.io/py-resounding-libraries/) available via GitHub Pages.
+
+## Installation and Setup
+
+### Setting up virtual enviroment
+
+Generate the virtual enviroment on your project folder:
+
+```bash
+# Generate local python binaries in folder
+python3 -m venv rl-env
+```
+
+Activate virtual enviroment in order to invoke the package:
+
+```bash
+# activate the enviroment for this terminal
+source $rl-env/bin/activate
+```
+
+
+### Installation via pip
+
+```bash
+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:
+
+```json
+{
+	"koha": {
+		"oauth_credentials": {
+    	"description": "username",
+    	"client_id": "clientid generated by Koha",
+    	"secret_key": "secret key generated by Koha"
+		},
+	"basic_credentials": {
+    	"user": "user@email.com",
+    	"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](https://pymarc.readthedocs.io/en/latest/) and the [Koha REST API](https://api.koha-community.org/),  to allow batch operation for your library catalogue and enriching metadata scripts with external linked open data information from [Wikidata](https://www.wikidata.org/).
+
+### ResourceSpace
+[Resourcespace](https://www.resourcespace.com/) 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](https://orcid.org/) 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](https://researchportal.be/en).
+
+In the module `orcid` you can find some useful Python scripts, build upon [pyOrcid](https://github.com/sri0606/PyOrcid)to dynamically interact with your ORCID instance.
+
+**NOTE**: Still in development...

pyreslib-0.1.0/README.md

@@ -0,0 +1,98 @@
+# py-resounding-libraries
+Python package for digital libraries from the Resounding Libraries cluster at Orpheus Instituut.
+
+## Documentation
+
+[Package documentation](https://nicholascorniaorpheus.github.io/py-resounding-libraries/) available via GitHub Pages.
+
+## Installation and Setup
+
+### Setting up virtual enviroment
+
+Generate the virtual enviroment on your project folder:
+
+```bash
+# Generate local python binaries in folder
+python3 -m venv rl-env
+```
+
+Activate virtual enviroment in order to invoke the package:
+
+```bash
+# activate the enviroment for this terminal
+source $rl-env/bin/activate
+```
+
+
+### Installation via pip
+
+```bash
+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:
+
+```json
+{
+	"koha": {
+		"oauth_credentials": {
+    	"description": "username",
+    	"client_id": "clientid generated by Koha",
+    	"secret_key": "secret key generated by Koha"
+		},
+	"basic_credentials": {
+    	"user": "user@email.com",
+    	"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](https://pymarc.readthedocs.io/en/latest/) and the [Koha REST API](https://api.koha-community.org/),  to allow batch operation for your library catalogue and enriching metadata scripts with external linked open data information from [Wikidata](https://www.wikidata.org/).
+
+### ResourceSpace
+[Resourcespace](https://www.resourcespace.com/) 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](https://orcid.org/) 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](https://researchportal.be/en).
+
+In the module `orcid` you can find some useful Python scripts, build upon [pyOrcid](https://github.com/sri0606/PyOrcid)to dynamically interact with your ORCID instance.
+
+**NOTE**: Still in development...

pyreslib-0.1.0/pyproject.toml

@@ -0,0 +1,55 @@
+[project]
+name = "pyreslib"
+authors = [{name = "Nicholas Cornia", email = "nicholas.cornia@orpheusinstituut.be"}]
+license = "MIT" 
+# classifiers = ["Private :: Do Not Upload"] # remove if you wish to publish to PyPI
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+]
+version = "0.1.0"
+description = "Python package for digital libraries from the Resounding Libraries cluster at Orpheus Instituut"
+keywords = ["koha", "wikidata", "digital-libraries", "transkribus","omekas","bibtex","marc","library-software"]
+readme = "README.md"
+requires-python = ">=3.10"
+dependencies = [
+    "bibtexparser>=1.4.4",
+    "omeka-s-tools>=0.3.0",
+    "pandas>=2.3.3",
+    "pymarc>=5.3.1",
+    "pyyaml>=6.0.3",
+    "requests>=2.33.1",
+    "requests-oauth2client>=1.8.0",
+    "sparqlwrapper>=2.0.0",
+    "urllib3>=2.6.3",
+    "wikibaseintegrator>=0.12.15",
+]
+
+[project.optional-dependencies]
+docs = [
+    "mkdocs>=1.6.1",
+    "mkdocs-material>=9.7.6",
+    "mkdocstrings[python]>=1.0.4",
+]
+dev = [
+    "pytest>=7.0",
+    "black>=22.0",
+    "ruff>=0.1",
+]
+
+[tool.setuptools]
+packages = ["pyreslib"]
+
+[tool.setuptools.package-data]
+pyreslib = ["data/**/*"]
+
+[build-system]
+requires = ["setuptools>=68.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project.urls]
+Homepage = "https://nicholascorniaorpheus.github.io/py-resounding-libraries/"
+Repository = "https://github.com/NicholasCorniaOrpheus/py-resounding-libraries"

pyreslib-0.1.0/pyreslib/__init__.py

@@ -0,0 +1,9 @@
+"""
+py-resounding-libraries
+
+Python package from Resounding Libraries research cluster
+"""
+
+__version__ = "0.1.0"
+__author__ = "Nicholas Cornia"
+__credits__ = "Orpheus Instituut"