aboutsummaryrefslogtreecommitdiffstats
path: root/doc/source/installation.rst
blob: 42b1e4e635b10fd83f6635a779068c2db8755ca4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49

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

Installation
------------

Install *bsie* via pip::

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

This installs the `bsie` python package as well as the `bsie.app` command.
It is recommended to install *bsie* 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/bsie.git

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

    python setup.py develop

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

    # extra packages for tests
    pip install rdflib requests

    # code style discipline
    pip install mypy coverage pylint

    # documentation
    pip install sphinx sphinx-copybutton furo

    # packaging
    pip install build