Skip to content

CLI tool for crypto research (not maintained, moved to openbb terminal)

Notifications You must be signed in to change notification settings

JakubPluta/moonbag

Repository files navigation

Moon Bag Terminal

About The Project

Moonbag is Python Crypto CLI for exploring crypto trends, coins, DeFi protocols, NFTs and others.
It's highly inspired by the famous GamestonkTerminal

Installation

1. Clone Repository:

git clone https://github.com/JakubPluta/moonbag.git

2. Open project folder

cd moonbag/

3. Create and activate virtual environment:

python -m venv env
source env/Scripts/activate

4. Install Poetry:

pip install poetry

5. Install Dependencies

poetry install 

6. Configure API KEYS in order to be able to use all Moon Bag features.

You need to visit following places to get your API KEYS (all of them are free)

After you get your keys, you need to update it. You can do that in:

  • /moonbag/common/keys.py
  • or create .env file and store it there.
Adding keys to moonbag/common/keys.py
  • Open key.py file in your editor and add your keys to relevant variables
WALES_API_KEY = <Enter your key>
CC_API_KEY = <Enter your key>
REDDIT_CLIENT_ID = <Enter your client id>
REDDIT_CLIENT_SECRET = <Enter your client secret>
REDDIT_USER_AGENT = <Enter your client user agent>
CRYPTO_PANIC_API = <Enter your key>
BIT_QUERY_API = <Enter your key>
Adding keys to .env file.
  • Create .env file in your main folder
  • Open .env file in your editor and add your keys:
CC_API_KEY=<Enter your key>
WALES_API_KEY=<Enter your key>
REDDIT_CLIENT_ID=<Enter your client id>
REDDIT_CLIENT_SECRET=<Enter your client secret>
REDDIT_USER_AGENT=<Enter your client user agent>
CRYPTO_PANIC_API=<Enter your key>
BIT_QUERY_API = <Enter your key>

7. Start Moon Bag terminal:

# In main directory write in terminal:
python moon.py

If you are running moonbag on windows with bash terminal, and you are facing issues with encoding. Try to write at the beginning

chcp.com 65001
set PYTHONIOENCODING=utf-8

Disclaimer:

Project is in alpha stage. The test coverage is close to 0. Be aware that there there will be a lot of issues, bugs. Feel free to report all faced bugs. Improvements, new functionalities and tests will be added systematically.

Contributing

If you have an idea for improvement, new features. Pull requests are welcome.

License

MIT

Available features. (updated: 09.06.2021)

  • Coingecko
  • Cryptocompare
  • Coinpaprika
  • UniSwap (GraphQL)
  • Funding rates
  • Wales txs
  • Airdrops
  • DeFi stats
    • Defi Pulse
    • Lllama
  • Fear & Greed Index
  • Blockchain explorers for most popular chains
    • Ethereum
    • TerraLuna
  • Tests
  • Charts
  • Technical Analysis
  • Social media data
    • Reddit
    • 4Chan
    • BitcoinTalk

About

CLI tool for crypto research (not maintained, moved to openbb terminal)

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published