Stock & Crypto Ticker App (ticker)

A stock ticker strip that supports both stocks and cryptocurrencies.

NOTE: This project was generated with Cookiecutter along with @clamytoe's toepack project template.

Initial setup

cd Projects
git clone https://github.com/clamytoe/ticker.git
cd ticker

Anaconda setup

If you are an Anaconda user, this command will get you up to speed with the base installation.

conda env create
conda activate ticker

Regular Python setup

If you are just using normal Python, this will get you ready, but I highly recommend that you do this in a virtual environment. There are many ways to do this, the simplest using venv.

python3 -m venv venv
source venv/bin/activate
pip install -r requirements.txt

Final setup

pip install -e .

Usage

ticker

If all went well, you should be seeing a ticker strip near the bottom of your screen.

Configuring

Edit the portfolio.json file to add or remove stocks and cryptocurrencies. As of this version, you must have at least one of each.

{
    "stocks": [
        "AMD",
        "INTC",
        "NVDA",
        "PLTR",
        "SOFI"
    ],
    "crypto_keymap": {
        "bitcoin": "BTC",
        "ethereum": "ETH",
        "ripple": "XRP"
    }
}

Contributing

Contributions are welcomed. Tests can be run with with pytest -v, please ensure that all tests are passing and that you've checked your code with the following packages before submitting a pull request:

• black
• flake8
• isort
• mypy
• pytest-cov

I am not adhering to them strictly, but try to clean up what's reasonable.

License

Distributed under the terms of the MIT license, "ticker" is free and open source software.

Issues

If you encounter any problems, please file an issue along with a detailed description.

Changelog

• v0.1.0 Initial commit.