AlchemistPrimus / N2-Avionics-BaseStation

React and NodeJS Web application for graphing rocket telemetry data

Python Flask API For N2 Avionics Base Station

You require python 3 to use flask checkout its documentation at https://docs.python.org/3/

Installing Flask

To install flask, run the command below on the command line in the necessary virtual environment for your application.

pip install flask

Creating the application

Your programming environment set up, You can start using Flask. A simple flask application can be created in a python file as shown below

from flask import Flask

app=Flask(__name__)

@app.route('/')
def hello():
    return "Hello world"

Running the flask app

Save the created file and close. To run the web application, on your commandline, tell flask where to find the application via setting FLASK_APP environment variable as shown

export FLASK_APP=my_flask_file #use 'set' instead of export for linux

running it in development mode

export FLASK_ENV=development #use 'set' instead of export for linux

running the application, use the flask run commmand as shown

flask run

Output will be something like this

Output
 * Serving Flask app "hello" (lazy loading)
 * Environment: development
 * Debug mode: on
 * Running on http://127.0.0.1:5000/ (Press CTRL+C to quit)
 * Restarting with stat
 * Debugger is active!
 * Debugger PIN: 813-894-335
 

There you go! You have created a Flask application.

Flask is a microframework for building extensible web applications. To learn more about flask you can check its documentation at https://flask.palletsprojects.com/en/2.1.x/

PROJECT STRUCTURE

main/__-data_processing/#this directory contains all received data related tasks
       |
       |
       -models/#this directory contains database models
       |
       |
       -routes/__-#cointains routes to api endpoints
       |     |
       |     -auth/__#this directory contains api authentication endpoints
       |     |    |
       |     |    -auth_.py #this file contains api authentication end points
       |     |    -authforms.py #this file contains form for endpoints
       |     |
       |     -views/__#this directory contains api enpoints to serve data
       |         |
       |         -views_.py #this file cointains api data endpoints
       |         -views_forms_.py #form for views endpoints
       |
       -utils/__#this directry contains important utilities for the application
       |     |
       |     |
       |     -email/__#this folder contains email related functionalities
       |     |
       |     |
       |     -errors/__#this folder contains not global error handling
       |     |
       |     |
       |     -responses.py#handles api responses
       |
       |
       -tests/__#this folder contains tests related tasks
       |
       |
       |
       -avi_app.py#contains the script thats starts the application
       -config.py#contains the application configuration
       -requirements.txt#contains requirements to run the application