lacson/pyblabber repository overview

⁠pyblabber

Implementation of Blabber API in Python
(Semester Project for CS 2304 Spring 2019⁠, Virginia Tech)

⁠API Support

Pyblabber is designed to support the Blabber API.

A more in-depth list of the methods can be found here⁠.

⁠Setup

It is possible to run pyblabber natively or containerized in Docker.

⁠System Requirements and Defaults

• Python 3
• flask
• pymongo
• a running MongoDB server

By default, pyblabber runs on port 5000 (due to it being the default of Flask) but it is perfectly adjustable.

⁠Native Setup

(NOTE: This is perfectly possible and theoretically should work just fine, but you will have no ability to change the port used without editing the code directly. I make no guarantees of functionality since the preferred method of running pyblabber is through Docker.)

A requirements.txt file required by pip is included in the src/ folder. Once the required libraries are installed, just execute python3 src/pyblabber.py.

⁠Docker Setup

⁠Container Only

For convenience, the port used is a variable and can be changed in the Dockerfile. It is copied into the created image as an environment variable.

A Docker image can be created and run using the included Dockerfile. Commands for reference:

$ docker build -t pyblabber:latest .
$ docker container run -p <port>:<port> -it pyblabber

⁠Complete Development Environment

As of Milestone 2, a docker-compose file has been provided, enabling a full fledged development environment (complete with data persistence using MongoDB.)

To use this complete development environment, just run docker-compose up in the main directory.

⁠Roadmap

Just a short list of things to do:

• Handle custom time specification in GET method

• Abstract GET method logic away (made unnecessary due to simplification)

• Persist data using MongoDB

• Write integration test script (and maybe containerize it)