ccBitTorrent - High-Performance BitTorrent Client

🌍 Documentation Languages:

A modern, high-performance BitTorrent client built with Python asyncio, featuring advanced piece selection algorithms, parallel metadata exchange, and optimized disk I/O.

📚 Documentation

👉 View Full Documentation

The complete documentation is available at https://ccbittorrent.readthedocs.io/en/, including:

• Getting Started Guide - Step-by-step tutorial
• Configuration Guide - Configuration options
• Performance Tuning - Optimization guide
• API Documentation - Python API usage
• Architecture - Technical details
• Contributing Guide - Development setup
• BEP XET - XET protocol extension
• BEP 52 - BitTorrent v2 support

Quick Start

Installation with UV

# Install UV (if not installed)
curl -LsSf https://astral.sh/uv/install.sh | sh

# Install ccBitTorrent
uv pip install ccbittorrent

Your First Download

# Download from torrent file
uv run ccbt download movie.torrent

# Download from magnet link
uv run ccbt magnet "magnet:?xt=urn:btih:..."

# Launch Terminal Dashboard (Recommended)
uv run ccbt dashboard

For detailed installation instructions, usage examples, configuration, and more, visit the documentation site.

Contributing

1. Fork the repository
2. Create a feature branch
3. Make your changes
4. Add tests for new functionality
5. Run the test suite
6. Submit a pull request

For detailed development setup and guidelines, see the Contributing Guide.

License

This project is licensed under the GNU General Public License v2 (GPL-2.0) - see the License Documentation for the complete license text.

Additionally, this project is subject to additional use restrictions under the ccBT RAIL-AMS License - see the ccBT RAIL Documentation for the complete terms and use restrictions.

Important: Both licenses apply to this software. You must comply with all terms and restrictions in both the GPL-2.0 license and the RAIL license.