Skip to content

Latest commit

 

History

History
51 lines (41 loc) · 2.33 KB

README.md

File metadata and controls

51 lines (41 loc) · 2.33 KB

stuffnotifier

A thing which can notify you of:

  • cryptocurrency price movements, limits, and more with Gemini's API
  • Flight tracking and status via FlightAware's AeroAPI

via Discord, SMS, and potentially other forms of communication.

API Keys

Keys can be set in your shell's environment (ex. via a .env file), or passed as command line flags.

Mapping of keys to environment variables:

Key Description Environment Variable Default
Gemini API Key API key for Gemini GEMINI_API_KEY None
Gemini API Secret API Secret for Gemini GEMINI_API_SECRET None
FlightAware API Key API key for FlightAware Aero API FLIGHTAWARE_API_KEY None
Twilio Account SID Twilio Account SID (or API key SID) TWILIO_ACCOUNT_SID None
Twilio API Key Twilio API key (for SMS) TWILIO_API_KEY None
Twilio API Secret Twilio API secret TWILIO_API_SECRET None
Twilio Auth Token Twilio API Auth token TWILIO_API_TOKEN None
Discord Discord Bot Token DISCORD_TOKEN None
Slack Token Slack Bot token SLACK_TOKEN None
Redis Hostname Hostname of Redis instance/cluster REDIS_HOST localhost
Redis Port Port number of Redis instance/cluster REDIS_PORT 6379
Redis password Password for Redis instance authentication REDIS_PASSWORD ""

Supported notification methods

TODO

  • CLI (sorta done)
  • Gemini
    • Rest API integration
    • Websocket API integration
  • FlightAware integration (Flights, Airports)
  • Discord integration
  • Twilio integration
  • Slack integration (Untested)
  • Email integration
  • REST API service
  • Documentation