-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
44fddf2
commit 4749bff
Showing
1 changed file
with
7 additions
and
15 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,18 +1,10 @@ | ||
# mara-cli: Mara commandline app | ||
# Mara CLI | ||
|
||
A 'mara' command which exposes contributed click commands. Contributed click | ||
commands are exposed as subcommands. It automatically finds the | ||
`compose_mara_app()` function of your app, executes it, and then calls the | ||
appropriate subcommand. | ||
|
||
|
||
## Contributed MARA_* functionality in this package | ||
[![Build status](https://github.com/mara/mara-cli/actions/workflows/build.yaml/badge.svg)](https://github.com/mara/mara-cli/actions/workflows/build.yaml) | ||
![PyPI - License](https://img.shields.io/pypi/l/mara-cli.svg) | ||
[![PyPI version](https://badge.fury.io/py/mara-cli.svg)](https://badge.fury.io/py/mara-cli) | ||
[![Slack Status](https://img.shields.io/badge/slack-join_chat-white.svg?logo=slack&style=social)](https://communityinviter.com/apps/mara-users/public-invite) | ||
|
||
none | ||
|
||
## Consumed MARA_* functionality | ||
A 'mara' command which exposes contributed click commands. Contributed click | ||
commands are exposed as subcommands. It automatically provides click commands in entry point `mara.commands` of all installed libraries. | ||
|
||
This consumes the `MARA_CLICK_COMMANDS` functionality. `MARA_CLICK_COMMANDS` | ||
must be an iterable which yields `@click.command()` decorated functions | ||
(either an iterator or a functions which returns a list or a list of such | ||
functions). |