Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
crossjam committed Oct 18, 2023
1 parent 67a16c0 commit ed844af
Showing 1 changed file with 30 additions and 4 deletions.
34 changes: 30 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
# feedbin-tools

[![PyPI](https://img.shields.io/pypi/v/feedbin-tools.svg)](https://pypi.org/project/feedbin-tools/)
[![Changelog](https://img.shields.io/github/v/release/crossjam/feedbin-tools?include_prereleases&label=changelog)](https://github.com/crossjam/feedbin-tools/releases)
# [![PyPI](https://img.shields.io/pypi/v/feedbin-tools.svg)](https://pypi.org/project/feedbin-tools/)
# [![Changelog](https://img.shields.io/github/v/release/crossjam/feedbin-tools?include_prereleases&label=changelog)](https://github.com/crossjam/feedbin-tools/releases)
[![Tests](https://github.com/crossjam/feedbin-tools/workflows/Test/badge.svg)](https://github.com/crossjam/feedbin-tools/actions?query=workflow%3ATest)
[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/crossjam/feedbin-tools/blob/master/LICENSE)

Tools for Working with the Feedbin API
A command line toolkit for working with the [Feedbin HTTP API](https://github.com/feedbin/feedbin-api/)

## Installation

Install this tool using `pip`:

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

## Usage

Expand All @@ -23,6 +23,32 @@ 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 entries for the authed feedbin user and emit as JSON
feed Fetch entries for feedbin feed FEED_ID and emit as JSON
starred Fetch feedbin starred entries for the authed feedbin...
subscriptions Fetch feedbin subscriptions for the authed feedbin user...
```

## Development

To contribute to this tool, first checkout the code. Then create a new virtual environment:
Expand Down

0 comments on commit ed844af

Please sign in to comment.