Skip to content

Latest commit

 

History

History
92 lines (74 loc) · 3.15 KB

README.md

File metadata and controls

92 lines (74 loc) · 3.15 KB

DisGraph (HTN 2020++ Submission)

Example image with Geo Spatial Graph

Table of Contents

About the Project

Wanting to explore a unique way to share CSV/Excel data through the Dropbase API, we thought about the platform through which we were all communicating on. Discord. So we decided to create DisGraph , a Discord bot that can read in your data from a .csv and return a graph.

How will Joon take the bot further? First, fix as much of the known problems as possible. Disgraph was never perfect, and never was going to be perfect since half of it was designed by 4 high school students with a lot of caffeine in their systems at 4am. Second, expand the functionality beyond .csv file recognition. Third, honestly I haven't thought this far, but we'll see how things go :)

Example image with Geo Spatial Graph

Getting Started

At the moment the bot doesn't have a public link as it isn't hosted 24/7. But, if you'd like to host the bot yourself you can.

Requirements

  • Python 3.10 or greater
  • Libraries from requirements.txt satisfied
    • Follow steps in Installation to install required dependencies

Installation

  1. Clone the repo git clone https://github.com/brandonnly/HTN-2020.git
  2. Install the required libraries pip install -r requirements.txt
  3. Set up a bot account
  4. Set up your Dropbase database with 4 tables ( one for each dataset template )
    • x_vs_yy
    • name_vs_count
    • geodot
    • geospatial
  5. Setup environment variables with your API keys
    • BOT_TOKEN
    • DROPBASE_API_KEY
    • DROPBASE_ACCESS_KEY
    • X VS Y TABLE
    • NAME VS COUNT TABLE
    • GEODOT TABLE
    • GEOSPATIAL TABLE

Usage

DisGraph has a few commands available:

d!graph_file: Running the command will guide you through the process. The bot will automatically analyze the given data and give you the appropriate graph types available for the dadta.

Graph Types

  • 2-variable graphs (bar, line, scatter)
    • Data file must have 2 columns and equal number of rows with valid data
  • n-variable graph (pie)
    • Data file must have exactly 2 rows and n columns, where the first row contains the name of the data below it

License

This project is released under the MIT license, see LICENSE for more info.

HTN 2020++ Group

Brandon Ly - branonly.me

Jerome Philip - LinkedIn - jeromephilip.com/

Farzad Rahman - farzadr-dev.github.io/

Joonseo Lee - LinkedIn