directory_descriptions.md

Description of directories

As of 2022-11-01, this document might be outdated.

migrations

Auto generated

api.log

The log file for the flask application

an example logging statment is shown below in python3

 app.logger.info('%s logged in successfully', user.username)

Logging levels are set in flaskr/config.py

Refer to https://flask.palletsprojects.com/en/1.1.x/logging/ for more information

Note that this file should not be checked into git for versioning; it's now in the .gitignore file, which should hopefully prevent that happening.

flaskr

Flaskr is the main application. It contains all entry points to the application. __init__.py contains all the application macros.

flaskr/__init__.py

The primary file for all application macros

flaskr/config.py

The configuration directory for all macro config options. Generally development mode is being used.

flaskr/nscope

The nscope api python module. This contains numberscope endpoints and blueprints and models

flaskr/nscope/__init__.py

The main entry point to nscope, containing the blueprint for numberscope (imported in __init__.py in flaskr)

flaskr/nscope/models.py

Database models. See the example for how to define models as well as https://flask-sqlalchemy.palletsprojects.com/en/2.x/models/

flaskr/nscope/views.py

The primary blueprint for numberscope. This is the main application. Note that currently, there is only one endpoint (vuetest). But refer to the documentation within views on how to create a new route.

WSGI Setup

WSGI is setup on the production server. all wsgi instances and configurations are neglected in the github repository for security.

Documentation is in progress.

On the server, you may manage the status of the application by the systemd entry point for numberscope

$ sudo systemctl status numberscopeFlask.service

Numberscope is serving both index.html as well as the numberscope api routes declared inside flask.