Metadata-Version: 2.1
Name: torf-gui
Version: 0.2.2
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
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
License-File: LICENSE
Requires-Dist: torf >=4.2.2
Requires-Dist: humanfriendly >=10.0
Requires-Dist: PyQt5 >=5.15.9
Requires-Dist: pyqtdarktheme >=2.1.0

# torf-gui


[![GitHub Build Status](https://img.shields.io/github/actions/workflow/status/SavageCore/torf-gui/build.yml?style=flat-square&logo=pytest)](https://github.com/SavageCore/torf-gui/actions/workflows/build.yml)
[![Code Style: black](https://img.shields.io/badge/code%20style-black-black)](https://pypi.org/project/black/)

[![PyPI - Downloads](https://img.shields.io/pypi/dm/torf-gui?style=flat-square&logo=pypi)](https://pypi.org/project/torf-gui/)
[![PyPI - Version](https://img.shields.io/pypi/v/torf-gui?style=flat-square)](https://pypi.org/project/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 and macOS

You can find the latest releases [here](https://github.com/SavageCore/torf-gui/releases).

On Windows, simply download and run `torf-gui-win64.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).

On macOS, download and extract `torf-gui-macOS.zip` then run the app.
You may need to allow the app to run in your security settings.

### Linux

**Requirements**

-   Python 3.3+
-   PyQt5 5.7+
-   libxcb-xinerama0 (Debian/Ubuntu)

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/).

[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/E1E6P7VIQ)
