This is the Flask micro-framework API for Department and Employee details. Operations included, basic HTTP methods GET PUT DELETE and POST

Database: Mysql
Database ORM: SQLAlchemy

The detail information about database found in Database dump

Installation

The installation is very straightforward and make sure you are using at least python 3.6.x and later. Make sure pip setuptool is installed with python package.

Create virtual environment using following commands.

$ cd flask-crud-api
$ pip install virtualenv
$ virtualenv env

Activate virtual environment.

Linux or Mac

$ source env/bin/activate

OR

Windows

$ env\Scripts\activate

Deactivate virtual environment.

(env) $ deactivate

Install dependencies/packages.

(env) $ pip install -r requirements.txt

Running

Set environment variables in /.env file(like, Database credentials etc.).

When all dependencies are installed and configuration is set, run the api.

(env) $ python runserver.py

Access api by entering http://127.0.0.1:5000/ or http://localhost:5000/ url on browser.

Testing

Run the tests.

(env) $ py.test tests/ --cov src --cov-report term-missing

Note: Test cases are pending for this api.

For style guide enforcement (flake8)

(env) $ flake8 file_path/

Swagger

Swagger specification

References

• Python
• Flask
• SQLAlchemy
• Flake8