Installation

Requirements

• Python 3.8 or higher
• pandas
• requests

Install from PyPI

pip install tvscreener

Install from Source

git clone https://github.com/deepentropy/tvscreener.git
cd tvscreener
pip install -e .

Verify Installation

import tvscreener as tvs

ss = tvs.StockScreener()
df = ss.get()
print(f"Retrieved {len(df)} stocks")

Upgrade

pip install --upgrade tvscreener

Dependencies

tvscreener automatically installs these dependencies:

Package	Purpose
pandas	DataFrames for results
requests	HTTP requests to TradingView

Optional Dependencies

For styled output (colored tables):

pip install rich

For Jupyter notebook integration:

pip install ipywidgets

Troubleshooting

Import Error

If you get an import error, ensure you're using Python 3.8+:

python --version

Connection Issues

tvscreener connects to TradingView's public API. If you experience timeouts:

1. Check your internet connection
2. Try again (TradingView may be rate-limiting)
3. Use a VPN if TradingView is blocked in your region

No Data Returned

If ss.get() returns an empty DataFrame:

1. Check your filters - they may be too restrictive
2. Verify field names are correct (use autocomplete in your IDE)
3. Try without filters first: StockScreener().get()