RaRa Tools

Py3.10 Py3.11 Py3.12

rara-tools is a Python library containing various generic tools used by components of Kata.

✨ Features

Elasticsearch index & document operations
S3 file management operations
Task reporting to Core API
Converting SIERRA API responses to Pymarc compatible JSON

⚡ Quick Start

Get started with rara-tools in just a few steps:

Install the Package
Ensure you're using Python 3.10 or above, then run:
```
pip install rara-tools
```

Import and Use
Example usage to download a folder from S3:

from rara_tools.s3 import S3Files

s3 = S3Files(
     url="your-s3-address",
     access_key = "xxx",
     secret_key = "yyy",
     bucket = "my-sad-bucket"
)

s3.download("my-folder-in-s3")

⚙️ Installation Guide

Follow the steps below to install the rara-tools package, either via pip or locally.

Installation via `pip`

Click to expand

Set Up Your Python Environment
Create or activate a Python environment using Python 3.10 or above.
Install the Package
Run the following command:
```
pip install rara-tools
```

Local Installation

Follow these steps to install the rara-tools package locally:

Click to expand

Clone the Repository
Clone the repository and navigate into it:
```
git clone <repository-url>
cd <repository-directory>
```
Set Up Python Environment
Create or activate a Python environment using Python 3.10 or above. E.g:
```
conda create -n py310 python==3.10
conda activate py310
```
Install Build Package
Install the build package to enable local builds:
```
pip install build
```
Build the Package
Run the following command inside the repository:
```
python -m build
```
Install the Package
Install the built package locally:
```
pip install .
```

🚀 Testing Guide

Follow these steps to test the rara-tools package.

How to Test

Click to expand

Clone the Repository
Clone the repository and navigate into it:
```
git clone <repository-url>
cd <repository-directory>
```
Set Up Python Environment
Create or activate a Python environment using Python 3.10 or above.
Install Build Package
Install the build package:
```
pip install build
```
Build the Package
Build the package inside the repository:
```
python -m build
```
Install with Testing Dependencies
Install the package along with its testing dependencies:
```
pip install .[testing]
```
Run Tests
Run the test suite from the repository root:
```
python -m pytest -v tests
```

Metadata

Release files for rara-tools 0.9.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for rara-tools 0.9.2
File	Size	Uploaded
rara_tools-0.9.2.tar.gz	85.9 kB	Sep 17, 2026	Details

Built distribution (wheel)

Table of built distributions (wheels) for rara-tools 0.9.2
File	Interpreter	ABI	Platform	Reset
rara_tools-0.9.2-py3-none-any.whl 91.1 kB Sep 17, 2026	Python 3	none	any	Details

Total release size: 177.0 kB

Release files / rara_tools-0.9.2.tar.gz

Download URL	rara_tools-0.9.2.tar.gz
Size	85.9 kB
Tags	Source
SHA-256 checksum How to use checksums	`1e5198bbf69958e9cdcabf3001a6598e98f3c4cb973fa0fc4ccd796223622d02`
BLAKE2b-256 checksum How to use checksums	`5f9c8dcc3caa7e40c01627f9f657bff8cf748e3d92e7c0854bfd8f92726117ac`
Upload date	Sep 17, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/7.0.0 CPython/3.14.7`

Release files / rara_tools-0.9.2-py3-none-any.whl

Download URL	rara_tools-0.9.2-py3-none-any.whl
Size	91.1 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`3cf88a998f32ce784a0f0af233f7c02f92201960a7e1be0cf7554e3a8798e7ea`
BLAKE2b-256 checksum How to use checksums	`46189a07e41464cd601f103815f821f54430d4f5df35988357fa48910a728bc1`
Upload date	Sep 17, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/7.0.0 CPython/3.14.7`