```{toctree}
    :hidden:

installation
usage
api_reference
contributing

```

<div align="center">
  <picture>
    <source srcset="https://i.imgur.com/jrmxyXR.png" media="(prefers-color-scheme: dark)">
    <img src="https://i.imgur.com/mQE6c9Q.png" />
  </picture>
</div>

-----------------

[![Stars](https://img.shields.io/github/stars/DSAV-code/similator?style=social)](https://github.com/DSAV-code/similator)
[![Pypi Version](https://img.shields.io/pypi/v/similator)](https://pypi.org/project/similator)
[![Documentation Status](https://readthedocs.org/projects/similator/badge/?version=latest)](https://similator.readthedocs.io/en/latest/?badge=latest)
[![License GPL v3.0](https://img.shields.io/badge/license-GPL%20v3.0-blue.svg)](LICENSE)
[![GitHub issues](https://img.shields.io/github/issues/DSAV-code/similator.svg)](https://github.com/DSAV-code/similator/issues)
[![Python Version](https://img.shields.io/badge/python-3.8%2B-brightgreen.svg)](https://www.python.org/downloads/)

# Similator: Revolutionary Python-Rust Hybrid for Lightning-Fast Text Validation

Welcome to **Similator**, a hybrid Python-Rust library designed for ultra-fast text validation and comparison tasks. This project leverages the power of Rust to enhance performance while maintaining the flexibility and ease of use of Python.

## 🚀 Key Features

- **Python-Rust Hybrid**: Combines Python's simplicity with Rust's performance.
- **Fast Text Comparison**: Leverages Rust functions for optimized text comparison and search.
- **Easy to Use**: Simple APIs to get started with text validation and data handling.

## 📦 Project Structure

The project is composed of the following main files:

- **`text_similator.py`**: Contains the `TextSimilator` class, which integrates Rust functions for fast text comparison and search.
- **`valid_data.py`**: Contains the `ValidData` class, responsible for handling data validation tasks.
- **`memory.py`**: Contains the `Memory` class, which manages in-memory operations efficiently.
- **`lib.rs`**: The core Rust file exporting the `_rst_similator` module with `rst_compare` and `rst_search` functions.

## 📖 Documentation Contents

- [Installation](installation): How to install the Similator library.
- [Usage](usage): Examples of how to use the main classes and functions.
- [API Reference](api_reference): Detailed reference of the available classes and methods.
- [Contributing](contributing): Guidelines for contributing to the project.

## 📝 License

This project is licensed under the **GPL v3.0**. See the [LICENSE](LICENSE) file for more details.

## ⭐️ Get Involved!

Feel free to explore the [repository](https://github.com/DSAV-code/similator), give us a star, report issues, or contribute to the project!