Skip to content

Commit

Permalink
docs: add click extension information (#173)
Browse files Browse the repository at this point in the history
  • Loading branch information
eonu authored Dec 29, 2024
1 parent ae85e40 commit 41b6fa9
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -757,6 +757,24 @@ Repeat for confirmation: ***
</tr>
</table>

### Integrations

As Feud commands and groups compile to Click objects under the hood,
this opens up the ability to interact with all integrations that Click
supports.

- To convert a `feud.Group` into a `click.Group`, use the `.compile()` method defined on `feud.Group`.
- The `@feud.command` decorator converts a function into a `click.Command`.

Once you have a `click.Command` or `click.Group` produced by Feud,
it is possible to use it with Click extensions such as:

- [`click-man`](https://github.com/click-contrib/click-man): Automate generation of manual pages for Click applications.
- [`click-completion`](https://github.com/click-contrib/click-completion): Add or enhance `bash`, `fish`, `zsh` and `powershell` completion in Click.
- [`sphinx-click`](https://github.com/click-contrib/sphinx-click): A Sphinx plugin to automatically document Click-based applications.

For more examples of Click extensions, see the [`click-contrib`](https://github.com/click-contrib/) project.

## Installation

You can install Feud using `pip`.
Expand Down

0 comments on commit 41b6fa9

Please sign in to comment.