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

Copyright (c) 2022, Matthias Baumgartner
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
    * Redistributions of source code must retain the above copyright
      notice, this list of conditions and the following disclaimer.
    * Redistributions in binary form must reproduce the above copyright
      notice, this list of conditions and the following disclaimer in the
      documentation and/or other materials provided with the distribution.
    * Neither the name of bsie nor the
      names of its contributors may be used to endorse or promote products
      derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL MATTHIAS BAUMGARTNER BE LIABLE FOR ANY
DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Source

Check out our git repository:

git clone https://git.bsfs.io/bsie.git

You can further install bsie via the ususal setuptools 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