Template

Author: manoharuss

.github/workflows/main.yml

@@ -0,0 +1,26 @@
+# This is a basic workflow to help you get started with Actions
+
+name: GITHUB CI
+
+# Controls when the action will run. Triggers the workflow on push or pull request
+# events but only for the master branch
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+# A workflow run is made up of one or more jobs that can run sequentially or in parallel
+jobs:
+  build:
+    runs-on: ubuntu-18.04
+    # Steps represent a sequence of tasks that will be executed as part of the job
+    steps:
+    # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
+    - uses: actions/checkout@v2
+      with:
+        python-version: '3.7.4'
+    # Runs a set of commands using the runners shell
+    - name: Setup Python Dependencies and Lint
+      run: |
+        pip3 install -r requirements.txt

README.md

@@ -1,2 +1,41 @@
-# python-api-boilerplate
-A flask based Python API boiler plate. General purpose API with API key security
+![GITHUB CI](https://github.com/manoharuss/python-api-example/workflows/GITHUB%20CI/badge.svg?branch=master)
+
+# python-api-example
+
+A flask based simple Python API example.
+
+## Setup
+
+**Python version**
+
+```
+
+$ python --version
+
+Python 3.7.4
+
+$ pip --version
+
+pip 20.1.1 from /Users/username/env/lib/python3.7/site-packages/pip (python 3.7)
+
+```
+
+**Install dependencies**
+
+```sh
+
+$ pip install -r requirements.txt
+
+```
+
+**Start app**
+
+```
+
+npm run lint
+
+npm start
+
+```
+
+Head over to http://0.0.0.0:80/ for seeing locally served README.md.

api/__init__.py

@@ -0,0 +1,22 @@
+import markdown
+import os
+
+# Import the framework
+from flask import Flask
+
+# Create an instance of Flask
+app = Flask(__name__)
+
+# At the very start of the page, just show the rendered markdown
+@app.route("/")
+def index():
+    """Present some documentation"""
+
+    # Open the README file
+    with open(os.path.dirname(app.root_path) + "/README.md", "r") as markdown_file:
+
+        # Read the content of the file
+        content = markdown_file.read()
+
+        # Convert to HTML
+        return markdown.markdown(content)

package-lock.json

@@ -0,0 +1,22 @@
+{
+  "name": "python-api-example",
+  "version": "1.0.0",
+  "description": "A python API example",
+  "main": "python run.py",
+  "scripts": {
+    "test": "npm run lint",
+    "lint": "black . && flake8 . --ignore=E501,E302",
+    "start": "python run.py"
+  },
+  "keywords": [
+    "python",
+    "python",
+    "api",
+    "example",
+    "python",
+    "template",
+    "api",
+    "template"
+  ],
+  "license": "MIT"
+}

package.json

@@ -0,0 +1,5 @@
+Flask==1.1.2
+flask-restful==0.3.8
+flake8==3.8.3
+markdown==3.2.2
+black==19.10b0

requirements.txt

@@ -0,0 +1,3 @@
+from api import app
+
+app.run(host="0.0.0.0", port=80, debug=True)