Stonks

Cryptocurrency data reporting bot. Extracts data from cryptocurrency market aggregators (CoinGecko/CoinMarketCap) and displays results via discord

Table of Contents

• Features

• Environment Variables

• Run Locally

  • With Docker
  • Without Docker

Features

• Display price data for cryptocurrencies available in CoinGecko/CoinMarketCap
• Display charting data for cryptocurrencies available in CoinGecko/CoinMarketCap
• Users may submit tokens to monthly drawing to then vote for the token they believe will perform the best
• Error handling
• Logging

Environment Variables

To run this project, you will need to add the following environment variables to your .env file

DISCORD_BOT_TOKEN - Token required to connect with your discord bot

COIN_MARKET_CAP_API_KEY - Token required to query CoinMarketCap for cryptocurrency market data

DB_NAME - Name of your database

DB_HOST - Host of your database

DB_USER - Database user

DB_PASSWORD - Database password for DB_USER

DB_PORT - Database port

Run Locally

Clone the project

  git clone https://github.com/Stonks-Luma-Liberty/Stonks.git

Go to the project directory

  cd Stonks

Install maturin

pip install maturin

Build python rust module

maturin build -m coinmarketcap_utils/Cargo.toml -r -o coinmarketcap_utils/dist

With Docker

Generate requirements.txt file

poetry export -f requirements.txt -o requirements.txt --without-hashes

Edit requirements.txt file (Specifically coinmarketcap_utils package).

coinmarketcap-utils @ file:///Stonks/coinmarketcap_utils/dist/coinmarketcap_utils-0.1.0.tar.gz

Use docker-compose to start the bot

docker-compose up -d --build

Without Docker

Install dependencies

  poetry install

Start the bot

  poetry run python main.py