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 ...
$