aboutsummaryrefslogtreecommitdiffstats
path: root/README
blob: 3326196f17acc875faba8f69d83a53ed6f00124e (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
51
52
53
54
55
56

Black Star Information Extraction
=================================


### Developer tools setup

#### Test coverage (coverage)

Resources:
* https://coverage.readthedocs.io/en/6.5.0/index.html
* https://nedbatchelder.com/blog/200710/flaws_in_coverage_measurement.html

Commands:
$ pip install coverage
$ coverage run ; coverage html ; xdg-open .htmlcov/index.html



#### Static code analysis (pylint)

Resources:
* https://github.com/PyCQA/pylint
* https://pylint.org/
* https://pylint.pycqa.org/en/latest/user_guide/messages/messages_overview.html#messages-overview

Commands:
$ pip install pylint
$ pylint bsie



#### Type analysis (mypy)

Resources:
* https://github.com/python/mypy
* https://mypy.readthedocs.io/en/stable/

Commands:
$ pip install mypy
$ mypy



#### Documentation (sphinx)

Resources:
* 
* 

Commands:
$ pip install ...
$