search

crossjam / feedbin-tools

A command line toolkit for working with the Feedbin HTTP API.
Apache License 2.0
0 stars 0 forks source link
api-client api-rest http rss

readme

feedbin-tools

Tests License

A command line toolkit for working with the Feedbin HTTP API

Right now we are focused on only reading (GET) from the Feedbin API for information retrieval, backup, collection, and analysis purposes. The cli is not intended to be a full fledged Feedbin client. If motivated, the mutating methods (PUT, POST) may be implemented in the future.

Installation

Install this tool using pip. Even better use pipx which should work perfectly fine with the URL below:

pip install git+https://github.com/crossjam/feedbin-tools.git

Usage

For help, run:

feedbin-tools --help

You can also use:

python -m feedbin_tools --help
Usage: feedbin-tools [OPTIONS] COMMAND [ARGS]...

  A command line toolkit for working with the Feedbin HTTP API
  https://github.com/feedbin/feedbin-api/

  Due to the use of the requests library for HTTP, .netrc is honored which is
  another means of setting the HTTP Basic Auth user and password for the feedbin
  endpoints

Options:
  --version          Show the version and exit.
  --log-format TEXT  Python logging format string
  --log-level TEXT   Python logging level  [default: ERROR]
  --log-file FILE    Python log output file
  --user TEXT        feedbin user, also via FEEDBIN_USER envvar
  --password TEXT    feedbin password, also via FEEDBIN_PASSWORD envvar
  --help             Show this message and exit.

Commands:
  entries        Fetch feed entries for feedbin user
  feed           Fetch feed entries for feedbin feed
  feedmeta       Retrieve feed metadata
  starred        Fetch starred entries for feedbin user
  subscriptions  Fetch feed subscriptions for feedbin user

Development

To develop this module further, first checkout the code. Then create a new virtual environment:

git clone +https://github.com/crossjam/feedbin-tools.git
cd feedbin-tools
python -m venv venv
source venv/bin/activate

Now install the dependencies and test dependencies:

pip install -e '.[test]'

To run the tests:

pytest

This is a hobby, side (very side) project. I’m grateful for PR submissions and filed issues, but responses might lag by quite a bit.