https://github.com/5hirish/flask-restful-template

Flask REST API Template
https://github.com/5hirish/flask-restful-template

celery docker docker-compose flask kubernetes postgresql python3 rabbitmq rest-api swagger travis-ci

Last synced: about 2 months ago
JSON representation

Flask REST API Template

• Host: GitHub
• URL: https://github.com/5hirish/flask-restful-template
• Owner: 5hirish
• License: gpl-3.0
• Created: 2019-05-30T07:26:03.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2022-12-08T06:01:49.000Z (about 2 years ago)
• Last Synced: 2023-03-10T14:38:58.824Z (almost 2 years ago)
• Topics: celery, docker, docker-compose, flask, kubernetes, postgresql, python3, rabbitmq, rest-api, swagger, travis-ci
• Language: Python
• Homepage: http://shirishkadam.com/
• Size: 149 KB
• Stars: 3
• Watchers: 2
• Forks: 2
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
## FooBar App: Flask RESTful Template

[![Python](https://img.shields.io/badge/python-3.4_3.5_3.6-blue.svg)]()

[![codecov](https://codecov.io/gh/5hirish/erpro/branch/master/graph/badge.svg)](https://codecov.io/gh/5hirish/flask-restful-template)

[![codacy](https://api.codacy.com/project/badge/Grade/a700a69ec99c46d4a5bef0eb6f774d78)](https://www.codacy.com/app/5hirish/flask-restful-template?utm_source=github.com&utm_medium=referral&utm_content=5hirish/flask-restful-template&utm_campaign=Badge_Grade)

[![travis](https://travis-ci.org/5hirish/flask-restful-template.svg?branch=master)](https://travis-ci.org/5hirish/flask-restful-template)

### Initial server set-up

1.  `git clone https://github.com/5hirish/flask-restful-template`

2. [Install RabbiMQ](https://tecadmin.net/install-rabbitmq-server-on-ubuntu/)

3. [Install Python3](https://help.dreamhost.com/hc/en-us/articles/115000702772-Installing-a-custom-version-of-Python-3)

4. [Install PostgreSQL](https://www.fullstackpython.com/blog/postgresql-python-3-psycopg2-ubuntu-1604.html)

5. [Setup Virtual Env for Python3](https://help.dreamhost.com/hc/en-us/articles/115000695551-Installing-and-using-virtualenv-with-Python-3)

#### Post-Installation

1) Activate virtual environment `source`

2) `pip install -r requirements.txt`

3) Update `.env` files; refer the `.env_sample` file

4) Clone unit files `*.service` to `/etc/systemd/system`

5) Set up AWS `.credentials` ARN roles, set up `.bash_profile` variables

#### Monitor

*   Flask: {baseUrl}:5000

*   RabbitMQ: {baseUrl}:15672

#### Documentation

*   Swagger API Documentation

#### Tests

*   9 unit test cases with 100% file coverage and 84% line coverage.