readme and changelog

1 files changed, 55 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..85cb68f
--- /dev/null
+++ b/README.md
@@ -0,0 +1,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
+
+