Giter VIP home page Giter VIP logo

fake-employee-api's Introduction

made-with-python Code style: black Checked with pylint Checked with flake8 Checked with mypy Build Status Coverage Status License

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

Development

Usage

Screenshot

Quick start

Please run next commands to start an app:

git clone [email protected]: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:

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

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.