torproxy_client

License PyPI version Publish to PyPI Python Version

TorProxy-Client

TorProxy-Client is a simple Python library to connect to the internet through the Tor network using a proxy. It helps developers easily route their traffic through the Tor network to achieve better anonymity.

Features

Prerequisites

Before using TorProxy-Client, you need to have Tor installed on your system. Below are the installation instructions for different platforms:

Windows

  1. Install Scoop if you haven’t already.
  2. Install Tor using the following command:

    scoop install tor
    

Alternatively, you can download the official Tor Browser from the Tor Project website, which will also install the Tor service.

  1. Ensure that the Tor service is running by checking that the Tor process is active in the task manager or using tor.exe.

macOS

  1. Install Homebrew if you haven’t already.

  2. Install Tor using the following command:

brew install tor
  1. Start Tor with the following command:
tor
  1. Ensure the Tor service is running by checking for the process using ps aux grep tor

Linux

For most Linux distributions, you can install Tor via the package manager.

Ubuntu/Debian

  1. Update your package list and install Tor:
sudo apt update
sudo apt install tor
  1. Start the Tor service:
sudo systemctl start tor
  1. Enable Tor to start on boot:
sudo systemctl enable tor

Fedora

  1. Install Tor using the following command:
sudo dnf install tor
  1. Start the Tor service:
sudo systemctl start tor
  1. Enable Tor to start on boot:
sudo systemctl enable tor

Arch Linux

  1. Install Tor using the following command:
sudo pacman -S tor
  1. Start the Tor service:
sudo systemctl start tor
  1. Enable Tor to start on boot:
sudo systemctl enable tor

Installation

To install TorProxy-Client, use pip:

pip install torproxy_client

Usage

Once installed, you can use TorProxy-Client to configure your application to route traffic through the Tor network.

from torproxy_client import TorProxyClient
import requests

# Initialize the Tor proxy client
proxy = TorProxyClient()

# Check if Tor connection is successful
if proxy.tor_initialize():
    print("Tor connection successful!")
else:
    print("Tor connection failed. Please check if the Tor service is running.")

# Request via Tor
url = "https://check.torproject.org"
response = requests.get(url)
print(response.text)

Dependencies