Skip to content

vss365today/api

main
Switch branches/tags
Code

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
db
 
 
log
 
 
src
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

#vss365 today API

REST API for #vss365 today

Required Configuration

  • Flask secret key (SECRET_KEY_API)
  • MariaDB instance + login keys (DB_USERNAME, DB_PASSWORD, DB_HOST, DB_DBNAME)
  • Mailgun API key authorized domain and mailing list address (MG_API_KEY, MG_DOMAIN, MG_MAILING_LIST_ADDR)
  • Twitter API v2 bearer token (TWITTER_BEARER)
  • Archive download directory (DOWNLOADS_DIR)
  • Prompt static images directory + temporary directory (IMAGES_DIR, IMAGES_DIR_TEMP)

Install

  1. Install Python 3.10+ and Poetry 1.1.0+
  2. Set missing configuration keys in appropriate configuration/*.json files
  3. Run poetry install
  4. Launch the app using the provided VS Code launch configuration

Note: when running in development mode, all email sending will be disabled and all email-related operations will pretend that they suceeded.

Build

  1. docker build -t vss365today-api:latest .

License

2019-2021 Caleb

MIT