61 lines
969 B
Markdown
61 lines
969 B
Markdown
Discord bot to track stock portfolios
|
|
|
|
## Install Guide
|
|
|
|
First, install dependencies and clone repo
|
|
```sh
|
|
# Required Dependencies
|
|
sudo apt install git python3.8 python pipenv
|
|
|
|
# Clone Repository
|
|
git clone git@git.sockspls.com:kate/stock-tracker-discord.git
|
|
```
|
|
|
|
Recommended: Install [MongoDB](https://docs.mongodb.com/manual/tutorial/install-mongodb-on-ubuntu/) (Otherwise, flat file is used)
|
|
|
|
Then, create pipenv environment
|
|
```sh
|
|
cd stock-tracker-discord
|
|
pipenv install
|
|
```
|
|
|
|
Setup config file
|
|
```sh
|
|
cp config.example.py config.py
|
|
nano config.py
|
|
```
|
|
|
|
Run script
|
|
```sh
|
|
pipenv run main.py
|
|
```
|
|
|
|
## Usage
|
|
|
|
```
|
|
Commands:
|
|
|
|
Syntax
|
|
command <required> [optional]
|
|
|
|
Add stock to portfolio
|
|
add <ticker> <amount>
|
|
|
|
Delete stock from portfolio
|
|
del <ticker>
|
|
|
|
Get Portfolio
|
|
portfolio
|
|
pf
|
|
|
|
Add stock to watchlist
|
|
watch <ticker> [expected price]
|
|
w <ticker> [expected price]
|
|
|
|
Remove stock from watchlist
|
|
unwatch <ticker>
|
|
|
|
Get Watchlist
|
|
watchlist [@user]
|
|
wl [@user]
|
|
```
|