<h1 align="center">🚀 tinyticker 🚀</h1>
<div align="center">
<img src="https://i.imgur.com/J4k3PCM.png" height=400>
<img src="https://i.imgur.com/QWP7bpH.png" height=400>
</div>
<p align="center">
<a href="https://pypi.org/project/tinyticker/"><img src="https://img.shields.io/pypi/v/tinyticker"></a>
<a href="./LICENSE.md"><img src="https://img.shields.io/badge/license-MIT-blue.svg"></a>
<a href="https://github.com/loiccoyle/tinyticker/actions/workflows/ci.yml"><img src="https://github.com/loiccoyle/tinyticker/actions/workflows/ci.yml/badge.svg"></a>
</p>
<hr/>
`tinyticker` uses a Raspberry Pi zero W and a small ePaper display to periodically display a stock or crypto chart.
A `flask` web interface is created to set the ticker options and control the Raspberry Pi.
`tinyticker` uses the [`cryptocompare`](https://github.com/lagerfeuer/cryptocompare) API to query the crypto price information, you'll need to get yourself a free [API key](https://min-api.cryptocompare.com/pricing). As well as the [`yfinance`](https://github.com/ranaroussi/yfinance) package to get the stock financial data.
## 🛒 Hardware
Shopping list:
- [Raspberry Pi Zero WH](https://www.adafruit.com/product/3708)
- One of these ePaper displays:
- [Waveshare ePaper 2.13in Black & White](https://www.waveshare.com/wiki/2.13inch_e-Paper_HAT)
- [Waveshare ePaper 2.13in Black, White & Red](<https://www.waveshare.com/wiki/2.13inch_e-Paper_HAT_(B)>)
- [Waveshare ePaper 2.13in Black, White & Yellow](<https://www.waveshare.com/wiki/2.13inch_e-Paper_HAT_(C)>)
- A micro sd card
## 📦 Installation
### Recommended setup
Flash the [tinyticker image](https://drive.google.com/drive/folders/1U-PGzkOtSynN6FGDq2MsXF9kXGdkzd0D) onto a SD card and you should be good to go.
> [!NOTE]
> To build your own image, see the [`pi-gen`](https://github.com/loiccoyle/pi-gen) repo.
### Manual setup
> [!NOTE]
> This is much more involved than the recommended setup and will most likely require some debugging.
<details>
<summary>Expand</summary>
I highly recommend using [comitup](https://github.com/davesteele/comitup) to setup the networking on your RPi.
- Write the `comitup` [image](https://davesteele.github.io/comitup/latest/comitup-lite-img-latest.html) to your sd card
- Boot up the RPi and setup the networking
- ssh into your RPi, you'll probably want to change the password while you're at it
- Enable the [SPI interface](https://www.raspberrypi-spy.co.uk/2014/08/enabling-the-spi-interface-on-the-raspberry-pi/)
- (Optional) rename the hostname of your RPi by editing the `/etc/hostname` and `/etc/hosts` file
- (Optional) rename the Wifi AP name by editing the `/etc/comitup.conf` file
- Install the `BCM2835` driver:
```sh
curl http://www.airspayce.com/mikem/bcm2835/bcm2835-1.60.tar.gz | tar xzv
cd bcm2835-1.60/
./configure
make
make install
```
- Install `pip`:
```sh
sudo apt install python3-pip
```
- Install dependency requirements:
```sh
sudo apt install libxml2-dev libxslt1-dev libatlas-base-dev ninja-build patchelf libopenjp2-7 libtiff-dev libjpeg-dev
```
- Install `tinyticker`:
```sh
pip install tinyticker
```
- To setup `tinyticker` to start on boot, copy over the [`systemd` unit files](./systemd) and enable them.
- On boot, a qrcode linking to the `flask` app will be flashed on the display
- Leave a star, reboot and HODL !
</details>
## 👢 First boot
On first boot, you will need to connect your RPi to your wifi network.
- Connect to the `tinyticker` wifi AP
- Select the wifi network you want your RPi to connect to
- Enter the wifi password
Your RPi will now connect to your wifi and the `tinyticker` services will start.
Once the web app is running, head over to `http://tinyticker.local` to configure it.
> The RPi zero isn't very fast, so be patient :)
Raw data
{
"_id": null,
"home_page": "https://github.com/loiccoyle/tinyticker",
"name": "tinyticker",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "raspberry-pi, ticker, stock, crypto, epaper, finance",
"author": "Loic Coyle",
"author_email": "loic.coyle@hotmail.fr",
"download_url": "https://files.pythonhosted.org/packages/db/91/39fc9dbbb062023ccabdeb11410480c4bc6a0ee63ac7f7cae5ed1a4d29eb/tinyticker-0.5.8.tar.gz",
"platform": null,
"description": "<h1 align=\"center\">\ud83d\ude80 tinyticker \ud83d\ude80</h1>\n<div align=\"center\">\n <img src=\"https://i.imgur.com/J4k3PCM.png\" height=400>\n <img src=\"https://i.imgur.com/QWP7bpH.png\" height=400>\n</div>\n<p align=\"center\">\n <a href=\"https://pypi.org/project/tinyticker/\"><img src=\"https://img.shields.io/pypi/v/tinyticker\"></a>\n <a href=\"./LICENSE.md\"><img src=\"https://img.shields.io/badge/license-MIT-blue.svg\"></a>\n <a href=\"https://github.com/loiccoyle/tinyticker/actions/workflows/ci.yml\"><img src=\"https://github.com/loiccoyle/tinyticker/actions/workflows/ci.yml/badge.svg\"></a>\n</p>\n<hr/>\n\n`tinyticker` uses a Raspberry Pi zero W and a small ePaper display to periodically display a stock or crypto chart.\n\nA `flask` web interface is created to set the ticker options and control the Raspberry Pi.\n\n`tinyticker` uses the [`cryptocompare`](https://github.com/lagerfeuer/cryptocompare) API to query the crypto price information, you'll need to get yourself a free [API key](https://min-api.cryptocompare.com/pricing). As well as the [`yfinance`](https://github.com/ranaroussi/yfinance) package to get the stock financial data.\n\n## \ud83d\uded2 Hardware\n\nShopping list:\n\n- [Raspberry Pi Zero WH](https://www.adafruit.com/product/3708)\n- One of these ePaper displays:\n - [Waveshare ePaper 2.13in Black & White](https://www.waveshare.com/wiki/2.13inch_e-Paper_HAT)\n - [Waveshare ePaper 2.13in Black, White & Red](<https://www.waveshare.com/wiki/2.13inch_e-Paper_HAT_(B)>)\n - [Waveshare ePaper 2.13in Black, White & Yellow](<https://www.waveshare.com/wiki/2.13inch_e-Paper_HAT_(C)>)\n- A micro sd card\n\n## \ud83d\udce6 Installation\n\n### Recommended setup\n\nFlash the [tinyticker image](https://drive.google.com/drive/folders/1U-PGzkOtSynN6FGDq2MsXF9kXGdkzd0D) onto a SD card and you should be good to go.\n\n> [!NOTE]\n> To build your own image, see the [`pi-gen`](https://github.com/loiccoyle/pi-gen) repo.\n\n### Manual setup\n\n> [!NOTE]\n> This is much more involved than the recommended setup and will most likely require some debugging.\n\n <details>\n <summary>Expand</summary>\n\nI highly recommend using [comitup](https://github.com/davesteele/comitup) to setup the networking on your RPi.\n\n- Write the `comitup` [image](https://davesteele.github.io/comitup/latest/comitup-lite-img-latest.html) to your sd card\n- Boot up the RPi and setup the networking\n- ssh into your RPi, you'll probably want to change the password while you're at it\n- Enable the [SPI interface](https://www.raspberrypi-spy.co.uk/2014/08/enabling-the-spi-interface-on-the-raspberry-pi/)\n- (Optional) rename the hostname of your RPi by editing the `/etc/hostname` and `/etc/hosts` file\n- (Optional) rename the Wifi AP name by editing the `/etc/comitup.conf` file\n- Install the `BCM2835` driver:\n\n ```sh\n curl http://www.airspayce.com/mikem/bcm2835/bcm2835-1.60.tar.gz | tar xzv\n cd bcm2835-1.60/\n ./configure\n make\n make install\n ```\n\n - Install `pip`:\n\n ```sh\n sudo apt install python3-pip\n ```\n\n - Install dependency requirements:\n\n ```sh\n sudo apt install libxml2-dev libxslt1-dev libatlas-base-dev ninja-build patchelf libopenjp2-7 libtiff-dev libjpeg-dev\n ```\n\n - Install `tinyticker`:\n\n ```sh\n pip install tinyticker\n ```\n\n - To setup `tinyticker` to start on boot, copy over the [`systemd` unit files](./systemd) and enable them.\n - On boot, a qrcode linking to the `flask` app will be flashed on the display\n - Leave a star, reboot and HODL !\n\n</details>\n\n## \ud83d\udc62 First boot\n\nOn first boot, you will need to connect your RPi to your wifi network.\n\n- Connect to the `tinyticker` wifi AP\n- Select the wifi network you want your RPi to connect to\n- Enter the wifi password\n\nYour RPi will now connect to your wifi and the `tinyticker` services will start.\n\nOnce the web app is running, head over to `http://tinyticker.local` to configure it.\n\n> The RPi zero isn't very fast, so be patient :)\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A tiny Raspberry Pi powered ePaper ticker.",
"version": "0.5.8",
"project_urls": {
"Homepage": "https://github.com/loiccoyle/tinyticker",
"Repository": "https://github.com/loiccoyle/tinyticker"
},
"split_keywords": [
"raspberry-pi",
" ticker",
" stock",
" crypto",
" epaper",
" finance"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3127753f8e0e8441c87284d49ba69607da2d8091a78cb81aa6b40aa26b023695",
"md5": "dfd9eb6fe00c228fab23ae65aae249c3",
"sha256": "ba5a3853ecec4e370f3cc3a7628cdbf7ca80a5de2935b689b59a42e961523756"
},
"downloads": -1,
"filename": "tinyticker-0.5.8-py3-none-any.whl",
"has_sig": false,
"md5_digest": "dfd9eb6fe00c228fab23ae65aae249c3",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 155442,
"upload_time": "2024-05-21T01:55:35",
"upload_time_iso_8601": "2024-05-21T01:55:35.175399Z",
"url": "https://files.pythonhosted.org/packages/31/27/753f8e0e8441c87284d49ba69607da2d8091a78cb81aa6b40aa26b023695/tinyticker-0.5.8-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "db9139fc9dbbb062023ccabdeb11410480c4bc6a0ee63ac7f7cae5ed1a4d29eb",
"md5": "1afc9bd3795bd6394087428b678a3c8f",
"sha256": "4d2562f5666bfb7aa137e39ec7eecc998b89a6b8599e48310df75058f5f2a57c"
},
"downloads": -1,
"filename": "tinyticker-0.5.8.tar.gz",
"has_sig": false,
"md5_digest": "1afc9bd3795bd6394087428b678a3c8f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 139915,
"upload_time": "2024-05-21T01:55:37",
"upload_time_iso_8601": "2024-05-21T01:55:37.350590Z",
"url": "https://files.pythonhosted.org/packages/db/91/39fc9dbbb062023ccabdeb11410480c4bc6a0ee63ac7f7cae5ed1a4d29eb/tinyticker-0.5.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-21 01:55:37",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "loiccoyle",
"github_project": "tinyticker",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "tinyticker"
}
JSON
