Skip to main content

CLI tool for creating, editing, and checking Bittorrent meta files. Support for all Bittorrent versions including hybrid torrent files.

Project description

torrentfile

torrentfile


Bittorrent File Creator (.torrent)

Codacy Badge codecov GitHub repo size GitHub License Workflow for python project GitHub Workflow Status

TorrentFile can create torrent files, Check content for accuracy and completeness with a .torrent file, and display detailed information contained in a .torrent file.

Features

  • Create meta files for Bittorrent v1, v2 and hybrid torrent files.
  • Display detailed information contained in torrent file.
  • Check/ReCheck content and torrent file for download completion details and data integrity.
  • Supports all .torrent files.
  • GUI project can be found at https://github.com/alexpdev/TorrentfileQt

Documentation

Documentation can be found in the ./docs directory, or online at https://alexpdev.github.io/torrentfile.

Installation

via PyPi

pip install torrentfile

via Git

git clone https://github.com/alexpdev/torrentfile.git
python setup.py install

download

Or download the latest release from the Release page on github. https://github.com/alexpdev/torrentfile/releases

CLI Help Message

usage: TorrentFile [-h] [-v] [-d] [-p] [-s <source>] [-c <comment>]
                   [-o <path>] [--meta-version <int>] [-l <int>]
                   [-t <url> [<url> ...]] [-r <.torrent>]
                   <content>

Create and/or ReCheck Bittorrent V1, V2, and Hybrid meta files.

positional arguments:
  <content>                             path to content file or directory

optional arguments:
  -h, --help                            show this help message and exit
  -v, --version                         show program version and exit
  -d, --debug                           output debug information
  -p, --private                         create file for private tracker
  -s <source>, --source <source>        specify source tracker
  -c <comment>, --comment <comment>     include a comment in file metadata
  -o <path>, --out <path>               output path for created .torrent file
  --meta-version <int>                  torrent file version.
                                        Options = 1, 2 or 3.
                                        (1) = Bittorrent v1 (Default)
                                        (2) = Bittorrent v2
                                        (3) = Bittorrent v1 & v2 hybrid

  -l <int>, --piece-length <int>        Fixed amount of bytes for each chunk of data. (Default: None)
                                        Acceptable input values include integers 14-24, which
                                        will be interpreted as the exponent for 2^n, or any perfect
                                        power of two integer between 16Kib and 16MiB (inclusive).
                                        Examples:: [--piece-length 14] [-l 20] [-l 16777216]

  -t <url> [<url> ...], --tracker <url> [<url> ...]
                                        one or more Bittorrent tracker announce url(s)
                                        Examples: [-a url1 url2 url3]  [--anounce url1]

  -r <.torrent>, --check <.torrent>, --recheck <.torrent>
                                        <.torrent> is the path to a .torrent meta file.
                                        Check <content> data integrity with <.torrent> file.
                                        If this is active, all other options are ignored
                                        (except --debug)

License

Distributed under the GNU LGPL v3. See LICENSE for more information.

https://github.com/alexpdev

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.1.0.tar.gz (724.0 kB view hashes)

Uploaded Source

Built Distributions

torrentfile-0.1.0-py3.9.egg (23.0 kB view hashes)

Uploaded Source

torrentfile-0.1.0-py3-none-any.whl (25.7 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