Stars Pypi Version Documentation Status License GPL v3.0 GitHub issues Python Version

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: How to install the Similator library.

  • Usage: Examples of how to use the main classes and functions.

  • API Reference: Detailed reference of the available classes and methods.

  • Contributing: Guidelines for contributing to the project.

📝 License

This project is licensed under the GPL v3.0. See the LICENSE file for more details.

⭐️ Get Involved!

Feel free to explore the repository, give us a star, report issues, or contribute to the project!