/easy-flask-server

A very simple flask server to upload and download files.

Primary LanguageJupyter Notebook

easy-flask-server

Running the server:

  1. Setting up flask app in terminal:
    • In Windows: set FLASK_APP=server.py
    • In Linux: export FLASK_APP=server.py
  2. To run the server: flask run

Optional:

  • to run flask app in debug mode set FLASK_DEBUG=1 or export FLASK_DEBUG=1 before running the server.
  • if LOGFILE is specified in .env the logger will write to that file.
  • if UPLOAD_DIRECTORY in .env is not specified it will default to api_uploaded_files

Usage

  • List uploaded files (No authentication required): GET request to <server-ip>/files
  • Upload files: POST request to <server-ip>/files/<file-name-with-extension> with allowed API-key in header (file may be renamed due to secure_filename()-function from flask) and file as attachment
  • Download files: GET request to <server-ip>/files/<file-name-with-extension> with allowed API-key in header

About

Uploading and downloading is only possible when the user gives an API-key that is also in the .env-file of the server in the ALLOWED_KEYS-variable.

Requirements
  • flask
  • dotenv