Skip to main content

Create Bittorent v1, v2 and hybrid meta files.

Project description

TorrentFile

torrentfile


GitHub repo size GitHub License PyPI - Downloads CI Codacy Badge Codacy Badge DeepSource codecov

🌐 Overview

A simple and convenient tool for creating, reviewing, editing, and/or validating bittorrent meta files (aka torrent files). torrentfile supports all versions of Bittorrent files, including hybrid meta files, and has full unicode support.

A GUI frontend for this project can be found at https://github.com/alexpdev/TorrentfileQt

🔌 Requirements

  • Python 3.7+
  • Tested on Linux, Windows and Mac

💻 Install

via PyPi:

pip install torrentfile

via Git:

git clone https://github.com/alexpdev/torrentfile.git
cd torrentfile
pip install .

Download pre-compiled binaries from the release page.

📚 Documentation

Documentation can be found here or in the docs directory.

torrentfile is under active development, and is subject to significant changes in the codebase between releases.

🚀 Usage

Basic Usage

Usage
=====
   torrentfile [options] <command> [command-options] ...

Create, edit, show details, and check any version Bittorrent file from command line

Commands
--------
    create (c, new)                   Create a torrent meta file.
    edit (e)                          Edit existing torrent meta file.
    magnet (m)                        Create magnet url from an existing Bittorrent meta file.
    recheck (r, check)                Calculate amount of torrent meta files content is found on disk.
    info (i)                          Show detailed information about a torrent file.

Usage examples can be found in the project documentation on the examples page.

📝 License

Distributed under Apache v2 software license. See LICENSE for more information.

💡 Issues & Requests & PRs

If you encounter any bugs or would like to request a new feature please open a new issue.

PRs and other contributions are welcome

https://github.com/alexpdev/torrentfile/issues


Creating Torrents

  • Basic torrent file createion
> torrentfile create /path/to/content
  • The -t --tracker -a --announce flags add one or more urls to list of trackers.
> torrentfile create /path/to/content --tracker http://tracker1.com

> torrentfile create -t http://tracker2 http://tracker3 --private /path/to/content

> torrentfile create --tracker http://tracker /path/to/content  

> torrentfile create -t http://tracker1 http://tracker2 /path/to/content
  • the --private flag indicates use by a private tracker
  • the --source flag can be used to help with cross-seeding
> torrentfile create --private --source EXAMPLE --tracker https://url1 https://url2

The options for controlling the progress bar using --prog or --progress:

  • 0 : show no progress bar at all
  • 1 : show progress bar (default)
> torrentfile -t http://tracker.com --progress 2 /path/to/content
> torrentfile --prog 0 /path/to/content
  • to specify the save location use the -o or --out flags
  • if the path points to directory the name of torrent is autofilled.
> torrentfile create -o /specific/path/name.torrent ./content
  • to create files using bittorrent v2 use --meta-version 2
  • likewise --meta-version 3 creates a hybrid torrent file.
> torrentfile create --meta-version 2 /path/to/content
> torrentfile create --meta-version 3 /path/to/content

Check/Recheck Torrent

  • recheck torrent file /path/to/some.torrent with /path/to/content
> torrentfile recheck /path/to/some.torrent /path/to/content

Edit Torrent

  • edit a torrent file
> torrentfile edit [options] <path>

Create Magnet

To create a magnet URI for a pre-existing torrent meta file, use the sub-command
magnet or m with the path to the torrent file.

> torrentfile magnet /path/to/some.torrent

Interactive Mode (expiremental)

Alternatively to supplying a bunch of command line arguments, interactive mode allows users to specify program options one at a time from a series of prompts.

  • to activate interactive mode use -i or --interactive flag
> torrentfile -i

GUI

If you prefer a windowed gui please check out the official GUI frontend here

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

torrentfile-0.7.10.tar.gz (42.9 kB view hashes)

Uploaded Source

Built Distributions

torrentfile-0.7.10-py3.10.egg (40.7 kB view hashes)

Uploaded Source

torrentfile-0.7.10-py3-none-any.whl (45.4 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page