Skip to content

Commit

Permalink
Implement automated inclusion of cli help output into documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
crossjam committed Oct 18, 2023
1 parent 8d86b8a commit de050e0
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 4 deletions.
20 changes: 17 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,15 +26,27 @@ You can also use:

python -m feedbin_tools --help


<!-- [[[cog
import cog
from feedbin_tools import cli
from click.testing import CliRunner
runner = CliRunner()
result = runner.invoke(cli.cli, ["--help"])
help = result.output.replace("Usage: cli", "Usage: feedbin-tools")
cog.out(
"```\n{}\n```".format(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
another means of setting the HTTP Basic Auth user and password for the feedbin
endpoints
Options:
--version Show the version and exit.
Expand All @@ -48,9 +60,11 @@ Options:
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...
starred Fetch feedbin starred entries for the authed feedbin user...
subscriptions Fetch feedbin subscriptions for the authed feedbin user...
```
<!-- [[[end]]] -->

## Development

Expand Down
2 changes: 1 addition & 1 deletion setup.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,11 @@ install_requires =
requests-cache
stamina
tenacity
keyring

[options.extras_require]
test = pytest
requests-mock
cogapp


[options.entry_points]
Expand Down

0 comments on commit de050e0

Please sign in to comment.