python-re3data 0.9.0

Description:

pythonre3data 0.9.0

python-re3data: The Pythonic client for the re3data API.

⚠️ Please note that this project is currently under active development. As such, it is considered a work in progress,
and breaking changes may be introduced at any time. We encourage users to frequently check back for updates and to
exercise caution when using this project in production environments. Contributions and feedback are welcome to help
move the project towards a more stable release (v1.0.0).




CI





Docs



Package



Meta




python-re3data is a Python library that simplifies interacting with the re3data (Registry
of Research Data Repositories) REST API, allowing you to easily retrieve and process
metadata about research data repositories in a convenient and Pythonic way.
>>> import re3data
>>> response = re3data.repositories.list()
>>> response
[RepositorySummary(id='r3d100010468', doi='https://doi.org/10.17616/R3QP53', name='Zenodo', link=Link(href='https://www.re3data.org/api/beta/repository/r3d100010468', rel='self'))]
... (remaining repositories truncated)

>>> response = re3data.repositories.get("r3d100010468")
>>> response
Repository(re3data_org_identifier='r3d100010468', repository_name=RepositoryName(value='Zenodo', language=<Languages.ENG: 'eng'>), additional_name=[], repository_url='https://zenodo.org/', repository_identifier=['FAIRsharing_doi:10.25504/FAIRsharing.wy4egf', 'RRID:SCR_004129', 'RRID:nlx_158614'])
... (remaining fields truncated)

Features

Pythonic API interactions: Interact with the re3data API in a Pythonic way, without having to worry about low-level
HTTP requests or XML parsing.
Repository metadata retrieval: Easily fetch and process metadata about research data repositories using
re3data.repositories.list().
Repository details retrieval: Get detailed information about a specific repository using
re3data.repositories.get(repository_id).
XML response parsers: API XML responses are parsed into Python dataclasses, providing convenient access to the
elements of the re3data.org Schema 2.2 XML Schema. This makes it easy to work
with the rich metadata provided by the API.
Flexible response options: The response type can be switched between:

dataclass (default): Returns a Python dataclass object, allowing convenient access to the element of the re3data
schema
response: Returns a Python object representing the API response
original XML: Returns the raw XML response from the API
JSON: Returns a JSON representation of the API response
dictionary: Returns a dictionary representation of the API response



Requirements
Python >= 3.10
python-re3data is built with:

HTTP Requests: httpx, a modern and efficient HTTP client library, handles all
API interactions.
XML Parsing: xsdata, a powerful tool for generating Python dataclasses from XML
schemas, simplifies processing of API responses.
Optional CLI: typer, a popular library for building command-line interfaces,
powers the user-friendly interface.

Installation
You can install python-re3data via pip from PyPI:
python -m pip install python-re3data

or pull the Docker image from GHCR:
docker pull ghcr.io/afuetterer/python-re3data:latest

For a more detailed guide, see Installation.
Documentation
The documentation is made with Material for MkDocs and is
hosted by GitHub Pages.
Similar Projects
There are a couple of similar projects available on GitHub, e.g. via the topic
re3data. Among them are these implementations in Python:



Project
Description
Last commit




py3data
py3data is a lightweight and thin Python interface to the beta version of the API.




License
python-re3data is distributed under the terms of the MIT License.