blob: 08707d353139fb37fb8453afc22201d581a1f2df (
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
50
|
tagit - the BSFS browser
========================
## Installation
You can install tagit via pip:
$ pip install --extra-index-url https://pip.bsfs.io tagit
## Development
Set up a virtual environment:
$ virtualenv env
$ source env/bin/activate
Install tagit as editable from the git repository:
$ git clone https://git.bsfs.io/tagit.git
$ cd tagit
$ pip install -e .
Install the following additional packages besides tagit:
$ pip install coverage mypy pylint
$ pip install sphinx sphinx-copybutton sphinxcontrib-video furo
$ pip install build
To ensure code style discipline, run the following commands:
$ coverage run ; coverage html ; xdg-open .htmlcov/index.html
$ pylint tagit
$ mypy
To build the package, do:
$ python -m build
To run only the tests (without coverage), run the following command from the **test folder**:
$ python -m unittest
To build the documentation, run the following commands from the **doc folder**:
$ make html
$ xdg-open build/html/index.html
|
