Metadata-Version: 2.1
Name: areader
Version: 0.1.1
Summary: Terminal based archives reader for Hyperkitty, GNU Mailman's archiver
Author-Email: Abhilash Raj <raj.abhilash1@gmail.com>
License: Apache-2.0
Requires-Python: >=3.10
Requires-Dist: textual>=0.30.0
Requires-Dist: httpx
Requires-Dist: marshmallow
Requires-Dist: timeago
Requires-Dist: orm[sqlite]>=0.3.1
Requires-Dist: greenlet>=2.0.2
Description-Content-Type: text/markdown

Archive Reader
==============

A terminal based archive reader for Hyperkitty, GNU Mailman's official archiver.

Screenshots
-----------

![Page Add Mailinglist](https://raw.githubusercontent.com/maxking/archive_reader/main/screenshots/page_subscribe_mailinglist.svg)

![Page View threads](https://raw.githubusercontent.com/maxking/archive_reader/main/screenshots/page_threads_list.svg)

![Page Read Thread](https://raw.githubusercontent.com/maxking/archive_reader/main/screenshots/page_read_thread.svg)

Using
-----

To run the app, you can install it using [Pipx](https://pypa.github.io/pipx/):

```bash
# Install using pipx.
$ pipx install areader

# Run the app:
$ areader
```

If you don't have Pipx, you can install directly in a venv to run:

```bash
# Setup a virtualenv to install the package.
$ python3 -m venv .venv
$ source .venv/bin/activate
$ pip install areader

# Run the app:
$ areader
```

Hyperkitty Configuration
------------------------

In order to use this app, the Pagination on the Hyperkitty's API needs to be set correctly.
