Fake employees API

A lightweight fake mock data API written in responder python HTTP service framework.

This application will parse fake (mock) employees JSON data and build an API to work with it. Please follow mock parser api app to see how it looks like.

Tools

Production

• python 3.7, 3.8
• responder framework
• heroku deployment

Development

• travis CI
• pytest framework
• black code formatter
• mypy static typer
• pylint code style
• flake8 code formatter

Usage

Quick start

Please run next commands to start an app:

git clone git@github.com:aiopymake/fake-employee-api.git
pip install -r requirements.txt
python mock_parser_api.py

Development

Testing

Please run the following script to tun unit tests:

pytest

Code analysis

In general static code analysis consists of following tools: black, flake8, pylint, mypy, and unittests accordingly.

To be able to start static code analysis locally please run following script from the root directory of the project:

./run-code-analysis.sh install-dependencies

Deployment

Please refer to deployment page to get instructions on how to provision an app.

Meta

Author – Volodymyr Yahello.

Distributed under the MIT license. See license for more information.

You can reach out me at:

• vyahello@gmail.com
• https://twitter.com/vyahello
• https://www.linkedin.com/in/volodymyr-yahello-821746127

Contributing

I would highly appreciate any contribution and support. If you are interested to add your ideas into project please follow next simple steps:

1. Clone the repository
2. Configure git for the first time after cloning with your name and email
3. pip install -r requirements.txt to install all project dependencies
4. pip install -r requirements-dev.txt to install all development project dependencies
5. Create your feature branch (git checkout -b feature/fooBar)
6. Commit your changes (git commit -am 'Add some fooBar')
7. Push to the branch (git push origin feature/fooBar)
8. Create a new Pull Request