Skip to main content

A terminal-based client for TheOldReader

Project description

OldNews - A terminal-based client for TheOldReader

OldNews

GitHub Actions Workflow Status GitHub commits since latest release GitHub Issues or Pull Requests GitHub Release Date PyPI - License PyPI - Python Version PyPI - Version

Introduction

OldNews is a terminal-based client for TheOldReader. It provides the ability to read news feeds while using TheOldReader as the server for your RSS/atom subscriptions.

OldNews is and generally always will be fairly opinionated about the "best" way to make use of TheOldReader (AKA how I like to use it); but where possible I want to keep it quite general so it will be useful to anyone.

Installing

pipx

The application can be installed using pipx:

$ pipx install oldnews

uv

The application can be installed using uv:

uv tool install oldnews

If you don't have uv installed you can use uvx.sh to perform the installation. For GNU/Linux or macOS or similar:

curl -LsSf uvx.sh/oldnews/install.sh | sh

or on Windows:

powershell -ExecutionPolicy ByPass -c "irm https://uvx.sh/oldnews/install.ps1 | iex"

Once installed run the oldnews command.

Getting started

OldNews only works if you have an account on TheOldReader. When you first run up OldNews you will get a login screen:

OldNews login

Enter your TheOldReader login details to log in.

[!IMPORTANT] OldNews doesn't store your user name or password locally. It passes the details to the API of TheOldReader and then gets and locally stores a token for working with the API.

Once logged in TheOldReader will start to download a history of articles form your subscriptions. From then on it will synchronise the read/unread status as you read articles, and will refresh with the server if you request a refresh, or when you next start the application (within a set time limit).

Reading an article with OldNews

Using OldNews

At the moment the best way to get to know OldNews is to read the helps screen; once in the main application you can see this by pressing F1.

OldNews help

You can also discover commands and their keyboard shortcuts using the command palette:

OldNews command palette

File locations

OldNews stores files in an oldnews directory within both $XDG_DATA_HOME and $XDG_CONFIG_HOME. If you wish to fully remove anything to do with OldNews you will need to remove those directories too.

Expanding for the common locations, the files normally created are:

  • ~/.config/oldnews/configuration.json -- The configuration file.
  • ~/.local/share/oldnews/* -- The locally-held data.

Getting help

If you need help, or have any ideas, please feel free to raise an issue or start a discussion.

TODO

See the TODO tag in issues to see what I'm planning.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

oldnews-1.4.0.tar.gz (38.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

oldnews-1.4.0-py3-none-any.whl (58.8 kB view details)

Uploaded Python 3

File details

Details for the file oldnews-1.4.0.tar.gz.

File metadata

  • Download URL: oldnews-1.4.0.tar.gz
  • Upload date:
  • Size: 38.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.6 {"installer":{"name":"uv","version":"0.11.6","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for oldnews-1.4.0.tar.gz
Algorithm Hash digest
SHA256 6ac9076c25dc7063e26c742fb41e7b29c6aba66333b3fb0aefc3a4ad1858d147
MD5 bebbdb72ac0ceeb09ea9bfb861f9611e
BLAKE2b-256 37c520bdf96acc055f1a86a21c4f00d3193abf1f1b1d1556abb8f158ebce976b

See more details on using hashes here.

File details

Details for the file oldnews-1.4.0-py3-none-any.whl.

File metadata

  • Download URL: oldnews-1.4.0-py3-none-any.whl
  • Upload date:
  • Size: 58.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.6 {"installer":{"name":"uv","version":"0.11.6","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for oldnews-1.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2468c85e265686805822aadf3bb57abe2f0c9958fc3ebeebe77b49fa5e73f71f
MD5 ec234fb03a200e2a2436f56757acad49
BLAKE2b-256 a68c89463d7cd93502ec048b8356188118507fb0b0ae248b96dcd8d0812da3c1

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page