Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/perdy/clinner
Command Line Interface builder that helps creating an entry point for your application.
https://github.com/perdy/clinner
cli command command-line command-line-tool main
Last synced: 3 months ago
JSON representation
Command Line Interface builder that helps creating an entry point for your application.
- Host: GitHub
- URL: https://github.com/perdy/clinner
- Owner: perdy
- License: gpl-3.0
- Created: 2017-03-01T00:00:21.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2022-03-09T22:29:07.000Z (almost 3 years ago)
- Last Synced: 2024-10-11T07:45:21.734Z (3 months ago)
- Topics: cli, command, command-line, command-line-tool, main
- Language: Python
- Size: 179 KB
- Stars: 8
- Watchers: 3
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Clinner
[](https://travis-ci.org/PeRDy/clinner)
[](https://codecov.io/gh/PeRDy/clinner)
[](https://badge.fury.io/py/clinner)
* **Version:** 1.12.3
* **Status:** Production/Stable
* **Author:** José Antonio Perdiguero López
Clinner is a library that provides some useful tools to create command line interfaces for your application
Check [Clinner docs].
## Features
Can **define commands** in multiple way:
* List of shell commands such as `["docker build", "docker push"]`.
* Python functions.
* Python async functions.
Clinner provides a set of **commands ready to use** like:
* Black.
* Flake8.
* Isort.
* Nosetest.
* Prospector.
* Pytest.
* Sphinx.
* Tox.
Hooks for **injecting variables** or **add global arguments** to your script.
## Quick start
Install this package using pip:
```bash
pip install clinner
```
Create a command
```python
from clinner.command import command
@command
def foo(*args, **kwargs):
return True
```
Create a main file:
```python
from clinner.run.main import Main
if __name__ == '__main__':
sys.exit(Main().run())
```
## Commands
Commands are declared using a decorator to register given functions. Commands are functions with the follow parameters:
1. `func`: Function that will be called when command would be executed.
2. `command_type`: Type of the command, could be a *bash* or *python* command.
3. `args`: Parser arguments for this command.
4. `parser_opts`: Command subparser's keywords, such as description.
This decorator allows to be used as a common decorator without arguments, where default type (*python*) will be used:
```python
@command
def foobar(*args, **kwargs):
pass
```
Or specifying the type:
```python
@command(command_type=CommandType.PYTHON)
def foobar(*args, **kwargs):
pass
```
But also is possible to provide command line arguments, as expected by argparse.ArgumentParser.add_argument:
```python
@command(args=((('-f', '--foo'), {'help': 'Foo argument that does nothing'}), # Command argument
(('--bar',), {'action': 'store_true', 'help': 'Bar argument stored as True'})), # Another argument
parser_opts={'title': 'foobar_command', 'help': 'Help for foobar_command'}) # Parser parameters
def foobar(*args, **kwargs):
pass
```
All commands will be registered in a command register that can be accessed through ``command.register``. Each entry in
this register is a dictionary with the fields declared at the beginning of this section.
### Shell command
Example of running `ls -la` shell command.
```python
@command(command_type=CommandType.SHELL)
def lsla(*args, **kwargs):
return [shlex.split("ls -la")]
```
### Python function
Run a python function.
```python
@command
def foo(*args, **kwargs):
return "foo"
```
### Python async function
Run a python async function.
```python
@command
async def bar(*args, **kwargs):
await asyncio.sleep(1)
return "bar"
```
## Main
A main class is defined to ease the creation of command line applications. This class follows the process:
1. Create a parser using ``argparse.ArgumentParser`` for the application:
a) Calling all ``add_arguments(parser)`` methods from all super classes, e.g: ``clinner.mixins.HealthCheckMixin``.
b) Addding a subparser for each command with their specific arguments.
2. Parse arguments using the argument parser created previously.
3. Inject variables into environment calling all super classes methods whose name starts with ``inject_``.
## Examples
Some Clinner examples.
### Simple Main
Example of a simple main with two defined commands `foo` and `bar`.
```python
#!/usr/bin/env python
import shlex
import sys
from clinner.command import command, Type as CommandType
from clinner.run.main import Main
@command(command_type=CommandType.SHELL,
args=(('-i', '--input'),
('-o', '--output')),
parser_opts={'help': 'Foo command'})
def foo(*args, **kwargs):
"""List of foo commands"""
ls_cmd = shlex.split('ls')
wc_cmd = shlex.split('wc')
wc_cmd += [kwargs['input'], kwargs['output']]
return [ls_cmd, wc_cmd]
@command(command_type=CommandType.PYTHON,
parser_opts={'help': 'Bar command'})
def bar(*args, **kwargs):
"""Do a bar."""
return True
if __name__ == '__main__':
sys.exit(Main().run())
```
### Builder Main
Example of main module with build utilities such as unit tests, lint, sphinx doc, tox and dist packaging:
```python
#!/usr/bin/env python
import sys
from clinner.run import Main
class Build(Main):
commands = (
'clinner.run.commands.black.black',
'clinner.run.commands.flake8.flake8',
'clinner.run.commands.isort.isort',
'clinner.run.commands.pytest.pytest',
'clinner.run.commands.sphinx.sphinx',
'clinner.run.commands.tox.tox',
)
if __name__ == '__main__':
sys.exit(Build().run())
```
Check [Clinner docs] to see more advanced examples.
[Clinner docs]: http://clinner.readthedocs.io