rara-tools 0.9.1

Tools to support Kata's work.

RaRa Tools

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:

1. Install the Package
   Ensure you're using Python 3.10 or above, then run:

   pip install rara-tools
   

2. 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

1. Set Up Your Python Environment
   Create or activate a Python environment using Python 3.10 or above.

2. 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

1. Clone the Repository
   Clone the repository and navigate into it:

   git clone <repository-url>
   cd <repository-directory>
   

2. 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
   

3. Install Build Package
   Install the build package to enable local builds:

   pip install build
   

4. Build the Package
   Run the following command inside the repository:

   python -m build
   

5. 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

1. Clone the Repository
   Clone the repository and navigate into it:

   git clone <repository-url>
   cd <repository-directory>
   

2. Set Up Python Environment
   Create or activate a Python environment using Python 3.10 or above.

3. Install Build Package
   Install the build package:

   pip install build
   

4. Build the Package
   Build the package inside the repository:

   python -m build
   

5. Install with Testing Dependencies
   Install the package along with its testing dependencies:

   pip install .[testing]
   

6. Run Tests
   Run the test suite from the repository root:

   python -m pytest -v tests
   

---