Metadata-Version: 2.0
Name: torf
Version: 1.5
Summary: High-level Python 3 module for creating and parsing torrent files
Home-page: https://github.com/rndusr/torf
Author: Random User
Author-email: rndusr@posteo.de
License: UNKNOWN
Keywords: bittorrent torrent bencode magnet
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.6
Requires-Dist: bencoder.pyx (<2.0.0,>=1.1.1)

torf
====

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
<https://en.wikipedia.org/wiki/Magnet_link#BitTorrent_info_hash_(BTIH)>`_.

It started as a fork of `dottorrent <https://github.com/kz26/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.

`torf-cli <https://github.com/rndusr/torf-cli>`_ is a command line tool that
makes use of torf.

Example
-------

.. code:: python

    from torf import Torrent
    t = Torrent(path='path/to/content',
                trackers=['https://tracker1.example.org:1234/announce',
                          'https://tracker2.example.org:5678/announce'],
                comment='This is a comment')
    t.private = True
    t.generate()
    t.write('my.torrent')

Documentation
-------------

Documentation is in the docstrings. Read it locally by running ``pydoc3
torf.Torrent`` after the installation. It's also available `online
<https://torf.readthedocs.io/>`_.

Installation
------------

torf is available on `PyPI <https://pypi.org/project/torf>`_.

The latest development version is in the master branch on `GitHub
<https://github.com/rndusr/torf>`_.

Contributing
------------

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

License
-------

`MIT <https://opensource.org/licenses/MIT>`_


