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

Install *BSFS* via pip::

    pip install --extra-index-url https://pip.bsfs.io bsfs

This installs the `bsfs` python package as well as the `bsfs.app` command.
It is recommended to install *bsfs* in a virtual environment (via `virtualenv`).


License
-------

This project is released under the terms of the 3-clause BSD License.
By downloading or using the application you agree to the license's terms and conditions.

.. literalinclude:: ../../LICENSE


Source
------

Check out our git repository::

    git clone https://git.bsfs.io/bsfs.git

You can further install *bsfs* via the ususal `setuptools <https://setuptools.pypa.io/en/latest/index.html>`_ commands from your bsfs source directory::

    python setup.py develop

For development, you also need to install some additional dependencies::

    # code style discipline
    pip install mypy coverage pylint

    # documentation
    pip install sphinx sphinx-copybutton furo

    # packaging
    pip install build