Metadata-Version: 2.1
Name: torf-gui
Version: 0.1.0
Summary: An advanced GUI torrent file creator with batch functionality, powered by PyQt and torf.
Home-page: https://github.com/SavageCore/torf-gui
Author: Oliver Sayers
Author-email: talk@savagecore.uk
Keywords: bittorrent torrent
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: End Users/Desktop
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
License-File: LICENSE
Requires-Dist: torf >=4.2.2
Requires-Dist: humanfriendly
Requires-Dist: PyQt5 >=5.7
Requires-Dist: pyqtdarktheme >=2.1.0

==============
torf-gui
==============

A quick and dirty port of `dottorrent-gui <https://github.com/kz26/dottorrent-gui>`_ for
`torf <https://github.com/rndusr/torf>`_

.. image:: img/screenshot_light.png
.. image:: img/screenshot_dark.png

--------
Features
--------

* Fast (capable of several hundred MB/s)
* Cross-platform
* Full Unicode support
* Use multiple CPU cores to compute piece hashes
* Automatic and manual piece size selection, up to 16MB
* Batch torrent creation mode
* Filename exclusion patterns (globs)
* HTTP/web seeds support `(BEP 19) <http://www.bittorrent.org/beps/bep_0019.html>`_
* Private flag support `(BEP 27) <http://www.bittorrent.org/beps/bep_0027.html>`_
* Randomize info hash to help with cross-seeding
* User-definable source string
* Optional MD5 file hash inclusion
* `Import/export of profiles <https://github.com/SavageCore/torf-gui/wiki/Profiles>`_ (trackers, web seeds, source string, filename exclusion patterns)
* Automatic dark mode!

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

Windows
-------

Binary releases of stable versions for 64-bit Windows can be found at
`https://github.com/SavageCore/torf-gui/releases <https://github.com/SavageCore/torf-gui/releases>`_.
Extract to a folder and run ``torf_gui.exe``. You may need to download and install the `Microsoft Visual C++ Redistributable for Visual Studio 2015 <https://www.microsoft.com/en-us/download/details.aspx?id=48145>`_.

Linux and Mac OS X
------------------

**Requirements**

* Python 3.3+
* PyQt5 5.7+

Latest stable release: ``pip install torf-gui``

Development: ``git clone`` this repository, then ``pip install .``

To run: ``torf-gui``

-------------
Portable Mode
-------------

torf-gui can be configured to run in portable mode, good for running from USB drives and network shares.
To enable this, simply create an empty file named ``torf-gui.ini`` in the same directory as the
main excecutable.

-------
License
-------

© 2023 Oliver Sayers. Made available under the terms of the
`GNU General Public License v3 <http://choosealicense.com/licenses/gpl-3.0/>`_.
