Metadata-Version: 2.4
Name: heathrow
Version: 0.2.2
Summary: Reference client for the Aquarius protocol
Author: Data Airspace Transport Authority
License-Expression: GPL-3.0-only
Project-URL: Homepage, https://gitlab.com/data-authority/heathrow
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: POSIX :: Linux
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console :: Curses
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Communications :: File Sharing
Classifier: Topic :: System :: Networking
Requires-Python: >=3.12
Description-Content-Type: text/plain
License-File: COPYING
Requires-Dist: rns
Provides-Extra: dev
Dynamic: license-file

Data Airspace Transport Authority proudly presents...


                             ⣠⣤   ⣠⣤   ⣠⣤  ⠘⣦⡀
                           ⣠⡾⠋⠘⣧⣠⡾⠋⠘⣧⣠⡾⠋⠘⣧  ⠘⣿⣦⡀
                          ⠚⠋   ⠘⠋   ⠘⠋  ⡀⠘⠃  ⠘⣿⣿⣶⡶
                                       ⣀⣽⣦⣤⣤⣤⣤⣼⣿⣿⣿⣦⣤⣤⣤⣄
                                       ⠉⣻⠟⠛⠛⠛⠛⢻⣿⣿⣿⠟⠛⠛⠛⠋
                             ⣠⣤   ⣠⣤   ⣠⣥    ⢠⣿⣿⠿⠷
                           ⣠⡾⠋⠘⣧⣠⡾⠋⠘⣧⣠⡾⠋⠘⣧  ⢠⣿⠟⠁
                          ⠚⠋   ⠘⠋   ⠘⠋   ⠘⠃⢠⠟⠁

            ▄   ▄   ▄▄▄▄  ▄▄▄▄▄  ▄▄▄▄▄▄▄  ▄   ▄   ▄▄▄▄   ▄▄▄▄▄   ▄     ▄
          ▄██▄▄█▀ ▄█▄▄  ▄██▄▄█▀   ▄█▀   ▄██▄▄█▀ ▄██▄ ▀ ▄█▀ ▄█▀ ▄█▀▄█ ▄█▀
         █▀  █▀ ▄█▄▄   █▀  █▀   ▄█▀    █▀  █▀  █▀  █▀ ██▄▄█▀  ██▄██▄█▀

          A BitTorrent compatible mesh network file sharing client


================================What is Heathrow?===============================

BitTorrent, the golden standard for decentralized filesharing protocols, lacks
guarantees of peer anonymity - we consider this an important drawback.

We propose a reimplementation of this protocol over the Reticulum
mesh network with the following improvements:
 - Peer privacy and anonymity guaranteed by the underlying Reticulum protocol
 - Trackerless peering by default
 - Privacy by default for all torrent filesets - metainfo hash acts as a
   password, and a fileset cannot be downloaded without knowing it

Aquarius is the name of the proposed protocol. 

Heathrow is the reference client for Aquarius, currently in public alpha.


=============================How do I use Heathrow?=============================

Heathrow comes as a TUI app compatible with existing V1 .torrent files.

To download a fileset that is available on the network, acquire the
corresponding magnet link or .torrent file and add it using the "New" menu
option (F4).

The fileset will start downloading automatically, provided peers are reachable.

To start seeding a fileset that you already own, choose the download directory
that corresponds to the path the files are available at.

As the protocol is not yet defined concretely, a plug-in system is available for
tuning the following components using CLI arguments:
 - Discovery - initial pre-handshake peer discovery logic.
 - Wire - translation layer between wire data and logical Aquarius packets.
 - Fileset - translation layer between on-disk files and fileset pieces.
 - Economy - main fileset piece exchange logic component.
 - Driver - application and UI logic for managing multiple filesets.

Use "heathrow --help" for more information.


================================Version history=================================

Version 0.1:
 - Initial public release

Version 0.2:
 - LTEP extension support
 - Magnet link support
