torf 1.0

High-level Python 3 module for creating and parsing torrent files

torf provides a high-level, flexible Torrent class that holds torrent metainfo and can export it to and import it from .torrent files. It can also create BTIH magnet links.

It started as a fork of dottorrent but turned into a rewrite with more features like full control over the torrent’s metainfo, validation, randomization of the info hash to help with cross-seeding and more.

Example

t = torf.Torrent(path='path/to/content',
                 trackers=['https://tracker1.example.org:1234/announce',
                           'https://tracker1.example.org:1234/announce'],
                 comment='This is a comment')
t.private = True
try:
    t.write(f)
except torf.WriteError as e:
    print(f'Cannot write file: {e}')
except torf.MetainfoError as e:
    print(f'Invalid torrent metainfo: {e}')

Documentation

Documentation is in the docstrings. Read it locally by running pydoc3 torf.Torrent after the installation. It’s also available online.

Installation

torf is available on PyPI.

The latest development version is in the master branch on GitHub.

Contributing

I consider this project feature complete, but feel free to request new features or improvements. Bug reports are of course always welcome.

License

MIT