installation.md 1.0 KB

Installation

Standard Installation

pip install twscrape

Development Version

Install the latest development version directly from GitHub:

pip install git+https://github.com/vladkens/twscrape.git

Requirements

  • Python 3.7+
  • asyncio support
  • Internet connection for Twitter/X access

Dependencies

The library automatically installs required dependencies:

  • httpx - Async HTTP client
  • aiosqlite - Async SQLite database
  • Additional dependencies as specified in setup.py

Verification

Verify installation:

# Check CLI is available
twscrape --help

# Check Python import works
python -c "from twscrape import API; print('OK')"

Upgrading

pip install --upgrade twscrape

Uninstallation

pip uninstall twscrape

Database Location

By default, twscrape creates accounts.db in your current working directory. You can specify a custom location:

api = API("path/to/custom.db")

Or via CLI:

twscrape --db path/to/custom.db <command>