Installation Guide
==================

.. note:: 
   To work with ``python-sage-bbb``, ensure that BigBlueButton (BBB) is set up on a server and that you have obtained your security salt key. Refer to the :ref:`conf_tools` for setting up BBB.

Step 1: Create a Virtual Environment
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

It's a good practice to use a virtual environment to manage dependencies for your project. To create a virtual environment, use the following command:

.. code-block:: bash

    python -m venv .venv

Replace ``.venv`` with your preferred name for the virtual environment.

Step 2: Activate the Virtual Environment
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Activate the virtual environment using the following command:

- On Windows:

  .. code-block:: bash

      .venv\Scripts\activate

- On macOS and Linux:

  .. code-block:: bash

      source .venv/bin/activate

Step 3: Install ``python-sage-bbb``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

With the virtual environment activated, install the ``python-sage-bbb`` package using pip:

.. code-block:: bash

    pip install python-sage-bbb

Install using Poetry
--------------------

Poetry is a dependency management tool for Python that ensures you have the right package versions and dependencies.

Step 1: Install Poetry
~~~~~~~~~~~~~~~~~~~~~~

If you haven't installed Poetry yet, you can do so by following the official installation instructions at the `Poetry website <https://python-poetry.org/docs/#installation>`_.

Step 2: Create a New Project (Optional)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

If you're starting a new project, you can create it using Poetry:

.. code-block:: bash

    poetry new myproject
    cd myproject

Replace ``myproject`` with your preferred project name.

Step 3: Add ``python-sage-bbb`` as a Dependency
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Add ``python-sage-bbb`` to your project dependencies using the following command:

.. code-block:: bash

    poetry add python-sage-bbb

This will install the package and update the ``pyproject.toml`` file with the new dependency.

Step 4: Activate the Virtual Environment
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Poetry automatically manages a virtual environment for your project. To activate it, use:

.. code-block:: bash

    poetry shell

Verification
------------

To verify the installation, you can run a simple script to import the package:

.. code-block:: python

    from sage_bbb.services.client import BigBlueButtonClient

    # Initialize the client
    bbb_client = BigBlueButtonClient(
        "https://your-bbb-server.com/bigbluebutton/api/",
        "your-security-salt",
    )

    # Check connection
    connection_status = bbb_client.check_connection()
    print(f"Connection Status: {connection_status}")

Run the script using the Python interpreter within your virtual environment or Poetry shell to ensure everything is set up correctly.