Preparing for development

1. Make sure you have Python 3.9 or higher installed (it's best to use pyenv for that, but you can use your system's Python 3.9 if you have to).

2. Install Poetry to manage dependencies.

3. Have Poetry install the project's dependencies (this will create a new virtualenv automatically):

   poetry install
   

4. Enter the virtualenv that was installed:

   poetry shell
   

5. If you use PyCharm, set the Python interpreter (Preferences > Project > Python Interpreter) to the same environment.

Running

uvicorn main:app --reload

Testing via the API

Creating a BDB:

$ httpx http://localhost:8000/bdbs -j '{"name":"foo","memory_size":2}'

Retrieving a BDB:

$ httpx http://localhost:8000/bdbs/1

Listing the BDBs:

$ httpx http://localhost:8000/bdbs