emarco177/my-yaml-course

my-YAML-course

An interface for a YAML databse.

This is a fastapi webserver that allows us to perform CRUD operations on YAML files. and can be refered to as a YAMLhouse or a YAML warehouse.

Demo

API Reference

Get all items

  POST /api/yamls

Payload	Type	Description
YAML	data-raw (x-yaml header)	Required. Your YAML file

Validates the YAML and saves it in the DB if exists (returns document uuid)

  GET /api/yamls/${id}

Parameter	Type	Description
id	string	Required. Id of document to fetch

Returns the YAML document as a JSON (if exists)

Environment Variables

To run this project, you will need to add the following environment variables to your .env file

PYTHONPATH should point to the root directory of the project

Run Locally

Clone the project

  git clone https://github.com/emarco177/my-YAML-course

Go to the project directory

  cd my_yaml_course

Install dependencies

  pipenv install

Start the server

  python app.py

Running Tests

To run tests, run the following command

  pytest . -s -v

🔗 Links