Stream Tool Installation
========================

You can install Stream Tool using different methods, including pip installation, cloning the GitHub repository, or downloading the tar.gz file.

Pip Installation
----------------

To install Stream Tool using pip, run the following command in your terminal or command prompt:

.. code-block::

    python -m pip install stream-tool

This will automatically download and install the latest version of Stream Tool from the Python Package Index (PyPI).

GitHub Repository
-----------------

You can also clone the GitHub repository to get the latest development version. Use the following command in your terminal:

.. code-block:: bash

    git clone https://github.com/pyskyler/stream-tool.git

This will clone the entire repository to your local machine. After cloning, navigate to the Stream Tool directory and run the following command to install it:

.. code-block:: bash

    python -m pip install .

Downloading Tar.gz File
------------------------

If you prefer to download a specific release version, visit the `GitHub Releases <https://github.com/pyskyler/stream-tool/releases>`_ page. Download the `stream_tool-x.x.x.tar.gz` file associated with the desired release.

After downloading the tar.gz file, navigate to the directory containing the file and run the following command to install Stream Tool:

.. code-block:: bash

    python -m pip install stream_tool-x.x.x.tar.gz

Replace ``x.x.x`` with the version number you downloaded.

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

Now you can make your first site with Stream Tool, :doc:`get started <getting_started>`!