blob: 85cb68f497c24713f4e84c788ef6d84c9af4168c (
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
|
# Black Star Information Extraction
The Black Star Information Extraction (BSIE) package provides a pipeline
to extract metadata and content-derived features from files and stores
that information in a BSFS storage.
## Installation
You can install BSIE via pip:
$ pip install --extra-index-url https://pip.bsfs.io bsie
## Development
Set up a virtual environment:
$ virtualenv env
$ source env/bin/activate
Install bsie as editable from the git repository:
$ git clone https://git.bsfs.io/bsie.git
$ cd bsie
$ pip install -e .
Install the following additional packages besides BSIE:
$ pip install coverage mypy pylint
$ pip install rdflib requests types-PyYAML
$ pip install sphinx sphinx-copybutton furo
$ pip install build
To ensure code style discipline, run the following commands:
$ coverage run ; coverage html ; xdg-open .htmlcov/index.html
$ pylint bsie
$ 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**:
$ sphinx-apidoc -f -o source/api ../bsie/ --module-first -d 1 --separate
$ make html
$ xdg-open build/html/index.html
|
