Metadata-Version: 2.4
Name: rudi-node-read
Version: 0.4.1
Summary: Use the external API of a RUDI Producer node
Author-email: Olivier Martineau <olivier.martineau@irisa.fr>
Maintainer-email: Olivier Martineau <olivier.martineau@irisa.fr>
License-Expression: EUPL-1.2
Project-URL: Homepage, https://github.com/OlivierMartineau/rudi-node-read
Project-URL: Documentation, https://app.swaggerhub.com/apis/OlivierMartineau/RUDI-PRODUCER
Project-URL: Changelog, https://github.com/OlivierMartineau/rudi-node-read/blob/release/CHANGELOG.md
Project-URL: Repository, https://github.com/OlivierMartineau/rudi-node-read
Keywords: rudi-node-read,rudi-node-get,RUDI,producer node,RUDI node,rudinode,open-data,Univ. Rennes
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Requires-Python: >=3.10
Description-Content-Type: text/markdown
Requires-Dist: deepdiff==9.1.0
Requires-Dist: puremagic==2.2.0
Provides-Extra: dev
Requires-Dist: Deprecated==1.3.1; extra == "dev"
Requires-Dist: PyYAML==6.0.3; extra == "dev"
Requires-Dist: commitizen==4.16.2; extra == "dev"
Requires-Dist: jaraco.collections==5.2.1; extra == "dev"
Requires-Dist: jupyter_client==8.8.0; extra == "dev"
Requires-Dist: jupyter_core==5.9.1; extra == "dev"
Requires-Dist: mdurl==0.1.2; extra == "dev"
Requires-Dist: pip-chill==1.0.5; extra == "dev"
Requires-Dist: pip-upgrade-outdated==1.5; extra == "dev"
Requires-Dist: pip3-autoremove==2.0.1; extra == "dev"
Requires-Dist: pkginfo==1.12.1.2; extra == "dev"
Requires-Dist: pre_commit==4.6.0; extra == "dev"
Requires-Dist: pure_eval==0.2.3; extra == "dev"
Requires-Dist: pytokens==0.4.1; extra == "dev"
Requires-Dist: readme_renderer==44.0; extra == "dev"
Requires-Dist: stack-data==0.6.3; extra == "dev"

[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)

# RUDI Node tools: _rudi-node-read_ library

This library offers tools to take advantage of
the [external API](https://app.swaggerhub.com/apis/OlivierMartineau/RUDI-PRODUCER) of a RUDI Producer node (also
referred as RUDI node).

The Jupyter notebook [README.ipynb](https://github.com/OlivierMartineau/rudi-node-read/blob/release/README.ipynb) offers
an overview of the available functionalities.

## Installation

```sh
pip install rudi-node-read
```

You don't need installing any additional library to use this.

## Usage

See [Python notebook](https://github.com/OlivierMartineau/rudi-node-read/blob/release/README.ipynb) for use examples.

## Testing

Rudi-node-read supports unit test discovery using Pytest:

```sh
dest_dir="rudi-node-read"
git clone https://github.com/OlivierMartineau/rudi-node-read.git $dest_dir
cd $dest_dir

python3 -m venv .venv
source .venv/bin/activate

pip install -r requirements-dev.txt

pytest
```

You may have a look at the [tests](https://github.com/OlivierMartineau/rudi-node-read/tree/release/tests) if you wish to see how every class or function is used.
