blob: ee6fadb0171e376708d995c0ce6067cbf21517ba (
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
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
|
Installation
============
You can install *bsie* via pip. BSIE comes with support for various file formats.
For this, it needs to install many external packages. BSIE lets you control
which of these you want to install. Note that if you choose to not install
support for some file types, BSIE will show a warning and skip them.
All other formats will be processed normally.
It is recommended to install *bsie* in a virtual environment (via ``virtualenv``).
To install only the minimally required software, use::
pip install --extra-index-url https://pip.bsfs.io bsie
To install all dependencies, use the following shortcut::
pip install --extra-index-url https://pip.bsfs.io bsie[all]
To install a subset of all dependencies, modify the extras part (``[image, preview]``)
of the follwing command to your liking::
pip install --extra-index-url https://pip.bsfs.io bsie[image,preview]
Currently, BSIE providesthe following extra flags:
* image: Read data from image files.
Note that you may also have to install ``exiftool`` through your system's
package manager (e.g. ``sudo apt install exiftool``).
* preview: Create previews from a variety of files.
Note that support for various file formats also depends on what
system packages you've installed. You should at least install ``imagemagick``
through your system's package manager (e.g. ``sudo apt install imagemagick``).
See `Preview Generator <https://github.com/algoo/preview-generator>`_ for
more detailed instructions.
* features: Extract feature vectors from images.
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
# external type annotations for pyyaml
pip install types-PyYAML
# documentation
pip install sphinx sphinx-copybutton furo
# packaging
pip install build
|
