Skip to content

Installation Guide

Overview

This guide provides step-by-step instructions for installing and setting up the TradingView Scraper library. Choose the method that best fits your needs: quick installation for users or development setup for contributors.

For End Users (Quick Install)

If you just want to use the library in your project:

Install from GitHub

pip install git+https://github.com/smitkunpara/tv-scraper.git

Install using UV

uv add git+https://github.com/smitkunpara/tv-scraper.git

For Developers (Full Setup)

This section is for contributors or those who want to modify the source code.

Prerequisites

Before installing the TradingView Scraper, ensure you have:

  • Python 3.11 or higher installed
  • UV package manager installed
  • Git (optional, for development setup)

Installation Steps

1. Install UV

If you don't have UV installed, install it first:

# On Windows
winget install --id=astral-sh.uv -e

# On macOS/Linux (using pip)
pip install uv

2. Clone the Repository (Development Setup)

For development or contribution purposes:

git clone https://github.com/smitkunpara/tv-scraper.git
cd tradingview-scraper

3. Install Dependencies

Install the required dependencies using UV:

# Install core dependencies
uv sync

# For development with testing capabilities
uv sync --extra test

4. Verify Installation

Verify that the installation was successful:

python -c "from tradingview_scraper import __version__; print(f'TradingView Scraper v{__version__}')"

Upgrading

To upgrade to the latest version:

# Pull the latest changes
git pull origin main

# Update dependencies
uv sync

This installation guide provides all necessary information to set up the TradingView Scraper library using UV. Refer to the specific module documentation for detailed usage instructions.