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

.. toctree::
    :maxdepth: 2
    :caption: Sections

Installing via Pip
------------------

Installing via pip makes the install very easy.

* ``pip3 install pyrebrandly``

Installing via source
---------------------

If you want to install via source, you have to download the source.

Git
    | GitHub - ``git clone https://github.com/ElectroCode/pyrebrandly``
    | GitLab - ``git clone https://gitlab.com/ElectroCode/pyrebrandly``
PyPi
    | ``pip3 download pyrebrandly``
    | ``pip3 install pyrebrandly -d <dir>`` - 'Downloads package into <dir> instead of installing, regardless of what\'s already installed'

    | You will want to run the following to get the dependencies for :bold:`pyrebrandly`
    | With Sudo - ``sudo pip3 install -r requirements.txt``
    | User Install - ``pip3 install -r requirements.txt --user``