Bishop

A Metadata API built using Python 3, FastAPI and backed by S3

Why

Bishop is a fit for situations where you want to store quick bits of facts without setting up an entire database for it.

Services like lambdas or cron jobs are a good fit since they normaly do not maintain state between runs or client apps that just need to know quick facts about a user or customer.

Below are some examples of the kinds of data you would use Bishop for.

• User preferences or facts ( should be emailed, has profile picture)
• Have we already emailed this account ?
• Did we already process this file ?
• How many times has an action/process occured

Quick Start

To get this project up and running locally on your computer:

1. Make sure you have Python 3.7 and pipenv installed on your machine.

2. Change sample.env to .env and add your S3 credentials

3. Assuming you have everything setup run the following commands:

   pipenv shell
   pipenv install
   cd app
   uvicorn main:app --reload
   
   # Running the tests
   pipenv install --dev
   pytest
   

4. Build and run the via docke

   # set environment variables in dockerfile before running commands below
   
   docker build -t bishop_image .
   docker run --name bishop_container -p 80:80 bishop_image
   
   # Go to http://localhost/
   

5. API docs can be found here http://localhost/redoc, currently only basic features are available.

   • Create or update metadata given an existing key
   • Retrieve metadata payload given a specific key
   • Delete metadata given a specific key

API Examples

A couple examples of the available endpoints.

Get metadata given a collection and key name
[ GET ] /collection/{collection_name}/key/{key}

Provided a JSON metadata payload, create a collection and key for payload
[ PUT ] /collection/{collection_name}/key/{key}