Skip to content

jlokos/datamule-discord

Repository files navigation

Datamule Discord Bot

This project uses datamule SEC Websocket to stream SEC filing data.

Features

  • SEC filing notifications
  • Company name resolution with ticker symbols
  • Performance statistics and monitoring

Prerequisites

  • Python 3.11+
  • Discord Bot Token
  • Datamule API Key
  • Discord Channel ID for notifications

Installation

Local Development

  1. Clone the repository:
git clone https://github.com/yourusername/datamule-discord.git
cd datamule-discord
  1. Create virtual environment:
python -m venv .venv
source .venv/bin/activate  # On Windows: .venv\Scripts\activate
  1. Install dependencies:
pip install -r requirements.txt
  1. Create .env file:
DISCORD_BOT_TOKEN=your_discord_bot_token
DISCORD_CHANNEL_ID=your_channel_id
DATAMULE_API_KEY=your_datamule_api_key
  1. Run the bot:
python bot.py

Deployment Options

Docker Deployment

  1. Build and run with Docker Compose:
docker-compose up -d
  1. View logs:
docker-compose logs -f
  1. Stop the bot:
docker-compose down

Bot Commands

  • !status - Show bot status and statistics
  • !ping - Check bot latency
  • !help - Show available commands

Environment Variables

Variable Required Default Description
DISCORD_BOT_TOKEN Yes - Your Discord bot token
DISCORD_CHANNEL_ID Yes - Channel ID for notifications
DATAMULE_API_KEY Yes - Datamule API key

Monitoring

The bot includes built-in monitoring:

  • Performance metrics in !status command

About

Discord bot that streams and notifies about SEC filings powered by datamule websocket.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors