Goldteeth
Monitors crypto/stock prices & volatility and plays an alert sound when a target is reached.
- It will also send a desktop notification on Linux or MAC OSX.
- Run via
pythonin a terminal or use the optional GUI.
Table of Contents
Usage
python src/goldteeth_cli.py <symbol> <mode> <target> <wav>
Price Targets
python src/goldteeth_cli.py btc above 100000 src/goldteeth/alert.wav
python src/goldteeth_cli.py eth below 3000 src/goldteeth/alert.wav
Volatility
python src/goldteeth_cli.py sol vol 10-5 src/goldteeth/alert.wav # 10% move in 5 mins
python src/goldteeth_cli.py doge vol 5-15 src/goldteeth/alert.wav # 5% move in 15 mins
python src/goldteeth_cli.py tsla vol 5-10 src/goldteeth/alert.wav # 5% move in 10 mins
Stocks
- Requires a Finnhub API key (free, email sign-up)
export FINNHUB_API_KEY="your_key_here"
python src/goldteeth_cli.py tsla above 400 src/goldteeth/alert.wav
Indices
- CBOE indices are fetched from CBOE's public delayed-quotes CDN, no API key required (about 15 minutes delayed).
VIXis accepted as an alias for the^VIXindex; other indices use the^prefix, e.g.^SPX,^DJI,^NDX.
# no FINNHUB_API_KEY needed
python src/goldteeth_cli.py ^vix above 30 src/goldteeth/alert.wav
python src/goldteeth_cli.py VIX vol 5-60 src/goldteeth/alert.wav
Limitations
- With the free API key Finnhub still limits you to one websocket connection.
- Goldteeth tries to work around this with recovery loops and HTTP fallback and will keep trying if using multiple instances.
- If you see this error it's due to free API limits, if you have a paid API key then you shouldn't see limits.
WebSocket error: Connection to remote host was lost.
WebSocket closed
Configuration
- Modify
CRYPTO_INTERVALto adjust crypto polling frequency (default: 60s) - Modify
STOCK_INTERVALto adjust stock ticker polling frequency (default: 120s) - Modify
SHOW_WS_ERRORSto show/hide websocket errors for stocks (default: False)
Requirements
- Python 3 with these libraries:
requestsorpython3-requestspytzorpython3-pytz(stocks only)websocketsorpython3-websockets(stocks only)
- mpv or mplayer (audio alerts)
GUI
- Right now the GUI is not available via
pip install
python src/goldteeth_gui.py
Installation
- There are two ways to Goldteeth:
- Clone repositry and run (ensure Python libraries are present)
pip install
Installation via Pip
python -m venv goldteeth
. !$/bin/activate
pip install goldteeth
Usage with Pip
alert.wavis included but you can pass your own audio file.
goldteeth btc below 88000
Installation via Repository
git clone https://github.com/sadsfae/goldteeth.git
cd goldteeth
Run from Repository
python src/goldteeth_cli.py tsla below 400 src/goldteeth/alert.wav
python src/goldteeth_cli.py btc vol 5-60 src/goldteeth/alert.wav
GUI Installation via Repository
- First make sure you have the repository cloned.
- Be inside the repository directory.
Generate GUI Desktop Shortcut
cat > goldteeth.desktop <<EOF
[Desktop Entry]
Version=1.0
Name=Goldteeth
Comment=Monitor crypto and stock prices
Exec=$(which python3) $(pwd)/src/goldteeth_gui.py
Path=$(pwd)/
Icon=utilities-system-monitor
Terminal=false
Type=Application
Categories=Utility;Finance;
EOF
Copy GUI Desktop Shortcut
mkdir -p ~/.local/share/applications/
mv goldteeth.desktop ~/.local/share/applications/
chmod +x ~/.local/share/applications/goldteeth.desktop
update-desktop-database ~/.local/share/applications/
- Goldteeth should now appear in your Applications menu in your favorite Desktop Environment.
Screenshots
CLI
GUI
Metadata
Release files for goldteeth 1.4.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| goldteeth-1.4.2.tar.gz | 55.2 kB | Without provenance | Details for goldteeth-1.4.2.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| goldteeth-1.4.2-py3-none-any.whl | Python 3 | none | any | Details for goldteeth-1.4.2-py3-none-any.whl |
Total release size: 95.6 kB
Release files / goldteeth-1.4.2.tar.gz
| Download URL | goldteeth-1.4.2.tar.gz |
|---|---|
| Size | 55.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
f66333f97565cd98c636d5bbc228e05006fe8fc4d62b9ad0b92abd2b608d7b35
|
|
BLAKE2b-256 checksum How to use checksums |
611b065405c08f2a49e021f1373e56eb60e1515905fd93de6ae45e0d1785579b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
Release files / goldteeth-1.4.2-py3-none-any.whl
| Download URL | goldteeth-1.4.2-py3-none-any.whl |
|---|---|
| Size | 40.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
3a8e9a66d4dc18bfc3a7b3c783a09b22e58eeefe108603c509a7b874b380cca6
|
|
BLAKE2b-256 checksum How to use checksums |
43c0b86036ae211e37327a4f828111a4f926ff317dcf5c1d4d04622a3b307f39
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
Security for goldteeth 1.4.2
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.