Installation
============

From PyPI (Recommended)
-----------------------

Install the latest stable version from PyPI:

.. code-block:: bash

   pip install ofire

From Source
-----------

Prerequisites
~~~~~~~~~~~~~

- Python 3.8 or higher
- Rust toolchain (for development)

Development Installation
~~~~~~~~~~~~~~~~~~~~~~~~

1. Clone the repository:

.. code-block:: bash

   git clone https://github.com/emberon-tech/openfire.git
   cd openfire

2. Create a virtual environment and install maturin:

.. code-block:: bash

   python -m venv venv
   source venv/bin/activate  # On Windows: venv\Scripts\activate
   pip install maturin

3. Build and install the Python package from source:

.. code-block:: bash

   maturin develop --manifest-path crates/python_api/Cargo.toml

Verify Installation
-------------------

Test that the installation works:

.. code-block:: python

   import ofire
   print("OpenFire installed successfully!")

Requirements
------------

- Python 3.8+
- Operating Systems: Linux, macOS, Windows