BLST

BLST is a RESTful API service for managing bucket lists and their constituent items. It is built using Flask and uses JSON objects for information interchange.

Project requirements

• Python
• Virtualenvwrapper
• Postgresql

Specifications

The following endpoints are accessible

Endpoint	Functionality
POST   /auth/login	Logs a user in
GET     /auth/logout	Logs a user out
POST   /bucketlists/	Creates a new bucket list
GET    /bucketlists/	Lists all the created bucket lists
GET    /bucketlists/<id>	Returns single bucket list matching <id>
PUT    /bucketlists/<id>	Update bucketlist matching <id>
DELETE  /bucketlists/<id>	Delete bucketlist matching <id>
POST     /bucketlists/<id>/items	Creates a new item in bucket list with matching <id>
PUT       /bucketlists/<id>/items/<item_id>	Update item in bucket list with matching <id>
DELETE /bucketlists/<id>/items/<item_id>	Delete item in bucket list with matching <id>

Installation

To run blst locally configure environment variables and do the following:

$ git clone https://github.com/collinmutembei/Bucketlist-API.git && cd $_

$ workon bucketlist-env

(bucketlist-env)$ pip install -r requirements.txt

(bucketlist-env)$ python manage.py db init

(bucketlist-env)$ python manage.py db migrate

(bucketlist-env)$ python manage.py db upgrade

(bucketlist-env)$ python manage.py runserver

Running tests

To run unit tests for blst

(bucketlist-env)$ python manage.py test