HTML Ingestor

A Python package for ingesting HTML documents while preserving semantic structure to generate RAG-friendly input documents and chunks.

Installation

You can install html-ingestor using pip:

pip install html-ingestor

Features

• Feature 1 (TBD)
• Feature 2 (TBD)
• Feature 3 (TBD)

Quick Start

from html_ingestor import ingest_html

# Example usage code will go here

Documentation

Detailed documentation is available at Read the Docs (Coming soon)

Development

This project uses Poetry for dependency management. To set up a development environment:

1. Clone the repository:

   git clone https://github.com/leobeeson/html-ingestor.git
   cd html-ingestor

2. Install dependencies:

   poetry install

3. Activate the virtual environment:

   poetry shell

4. Run tests:

   pytest

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

This project is licensed under the MIT License - see the LICENSE file for details.