rara-meta-extractor 0.0.4

Extracts relevant meta information for cataloging.

RaRa Meta Extractor

rara-meta-extractor is a Python library for extracting relevant meta information for cataloging.

---

✨ Features

• Coming soon

---

⚡ Quick Start

Get started with rara-meta-extractor in just a few steps:

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

   pip install rara-meta-extractor
   

2. Import and Use
   Example usage to link entries with default configuration:

    from rara_meta_extractor.llama_meta_extractor import LlamaExtractor
    from pprint import pprint
   
    text = """
        Toimetanud Milvi Teesalu
        Kaane kujundanud Piret Tuur
        Autoriõigus: Marje Ernits ja OÜ Eesti Raamat, 2019
        ISBN 978-9949-683-96-3
        ISBN 978-9949-683-97-0 (epub)
    """
   
    fields = ["editor", "designer", "isbn", "copyright", "title"]
   
    llama_extractor = LlamaExtractor(
        llama_host_url="http://local-llama:8080",
        fields=fields
    )
   
    extracted_info = llama_extractor.extract(text)
    pprint(extracted_info)
   

   Out:

   {
        'copyright': ['Marje Ernits ja OÜ Eesti Raamat, 2019'],
        'designer': ['Piret Tuur'],
        'editor': ['Milvi Teesalu'],
        'isbn': ['978-9949-683-96-3', '978-9949-683-97-0']
    }
   
   

---

⚙️ Installation Guide

Follow the steps below to install the rara-meta-extractor 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-meta-extractor
   

---

Local Installation

Follow these steps to install the rara-meta-extractor 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-meta-extractor 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
   

---

📝 Documentation

Documentation can be found here.

🔍 Usage Examples

Coming soon