https://github.com/Sumukh/create-flask-api

Create maintainable Flask APIs with scaffolding to get you off the ground quickly
https://github.com/Sumukh/create-flask-api

Last synced: 3 months ago
JSON representation

Create maintainable Flask APIs with scaffolding to get you off the ground quickly

• Host: GitHub
• URL: https://github.com/Sumukh/create-flask-api
• Owner: Sumukh
• Created: 2020-03-24T07:48:44.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-05-01T21:22:42.000Z (over 1 year ago)
• Last Synced: 2024-05-28T04:13:24.685Z (6 months ago)
• Language: Python
• Homepage: https://create-flask-api-6mlo8xyot.now.sh/api/info
• Size: 18.6 KB
• Stars: 5
• Watchers: 1
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• jimsghstars - Sumukh/create-flask-api - Create maintainable Flask APIs with scaffolding to get you off the ground quickly (Python)

README

        
# [](logo) Create Flask API (Flask Ignite)

A boilerplate Flask application on which to build APIs using best practices. Designed to be the API only alternative for [Flask Ignite](https://github.com/Sumukh/Ignite).

![Python application](https://github.com/Sumukh/create-flask-api/workflows/Python%20application/badge.svg)

- ✅ RESTful API (with argument validation & output schemas)

- ✅ 100% Code Coverage in Tests

- ✅ Using Flask Best Practices

- ✅ Support Deployment on Heroku, Now.sh

- ✅ With an example image API

## Installation

```bash

$ git clone

$ cd create-flask-api

$ python3 -m venv env; source env/bin/activate # To set up an virtual env

$ ./dev-server.sh # runs: FLASK_DEBUG="true" FLASK_APP="server:create_app" flask run

```

### Key Files:

The API Endpoints are defined in `server/api` and registered to specific routes in `server/api/__init__.py`.

* `server/api/__init__.py`

* `server/api/wallpaper.py`

* `tests/test_wallpaper_api.py`

## Testing

To test with a coverage report:

`pytest --cov-report term-missing --cov=server`

## Deployment

### Now.sh deployment

```bash

$ now

```

### Heroku Deployment

[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy)

## Limitations

This repo is designed to be the barebone setup for an API. If you want to hook into a database or do  authentication, you should look into [Flask Ignite](https://github.com/sumukh/ignite)