/freshworks-datastore

Repository with code for freshworks campus recruitment drive

Primary LanguagePython

freshworks-datastore

Repository with code for freshworks campus recruitment drive

Installation

Clone this and cd to the cloned directory

$ git clone https://github.com/BBloggsbott/freshworks-datastore
$ cd freshworks-datastore

Install required packages

$ pip install -r requirements

Run the server

Run with defaults

To run the server with default file names and save directories run the following command

$ python3 run.py

Run with custom directory

To run the server with custom save directory, use the following syntax

$ python3 run.py <save_dir>

Example:

$ python3 run.py data

Run with custom save directory and save file

To run the server with custom save directory and save file, use the following syntax

$ python3 run.py <save_dir> <save_file>

Example:

$ python3 run.py data data_saves.json

HTTP Endpoint

Create data

Use the below syntax to add data to the datastore

http://localhost:5000/create?key=<key>&value=<value>&timetolive=<tiletolive>

The timetolive parameter is optional

Read Data

Use the below syntax to read data from the datastore

http://localhost:5000/read?key=<key>

Delete Data

Use the below syntax to delete data from the datastore

http://localhost:5000/delete?key=<key>

When a request is processed, the response is returned with the appropriate status code.

Running Tests

To run tests, run the following command

$ python3 test_datastore.py