kaybee

Simple and lightweight knowledge base for recording arbitrary information. Data can be categorised and tagged to improve search and discovery. Associations can be created between data to group distinct but related information.

Build

The project depends on a number of Python and nodejs packages which are detailed in requirements.txt and package.json respectively. As such, you will need to have Python and node/npm installed for your system. The project has been built against Python 3.11 but has been tested against 3.10 without issues. Due to typing dependencies, it will not work against Python <= 3.9 out of the box. You might be able to fiddle the requirements but this won't be supported. It is advised that you create a Python virtualenv prior to using the make tooling or installing packages manually.

Automated option

All the necessary command execution can be achieved with the Makefile. make help will list out the available options.

The all command will perform installation of Python and JS dependencies, run the test suite, and then start the application. This is probably the command you want in most situations. You can drop the test step by using make run instead.

make all

Manual options

First install the dependencies.

pip install -r requirements.txt
npm install

Optional: run the test suite to make sure the application is working.

py.test tests

Then run the application with uvicorn. Make sure you're in the root directory of the project.

uvicorn kaybee.main:app --reload