https://github.com/andrewrosss/module-cli

Bootstrap extensible single-module python CLIs
https://github.com/andrewrosss/module-cli

cli command-line generator pipx python single-module

Last synced: 29 days ago
JSON representation

Bootstrap extensible single-module python CLIs

• Host: GitHub
• URL: https://github.com/andrewrosss/module-cli
• Owner: andrewrosss
• License: mit
• Created: 2022-03-31T17:55:14.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-04-18T16:04:54.000Z (over 2 years ago)
• Last Synced: 2024-10-03T10:34:01.171Z (about 2 months ago)
• Topics: cli, command-line, generator, pipx, python, single-module
• Language: Python
• Homepage:
• Size: 43.9 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# module-cli

Bootstrap extensible single-module python CLIs

[![PyPI Version](https://img.shields.io/pypi/v/module-cli.svg)](https://pypi.org/project/module-cli/)

[![codecov](https://codecov.io/gh/andrewrosss/module-cli/branch/main/graph/badge.svg?token=6LjO72NbGd)](https://codecov.io/gh/andrewrosss/module-cli)

[![Tests](https://github.com/andrewrosss/module-cli/workflows/Tests/badge.svg)](https://github.com/andrewrosss/module-cli/actions/workflows/test.yaml)

[![Code Style](https://github.com/andrewrosss/module-cli/actions/workflows/lint.yaml/badge.svg)](https://github.com/andrewrosss/module-cli/actions/workflows/lint.yaml)

[![Type Check](https://github.com/andrewrosss/module-cli/actions/workflows/type-check.yaml/badge.svg)](https://github.com/andrewrosss/module-cli/actions/workflows/type-check.yaml)

## Installation

### With `pipx`

This package is intended to generate python modules that function as CLIs and therefore shouldn't be a dependency of any module/package that it generates. **Because of this it's recommended to use this package via `pipx`**:

```bash

pipx run module-cli /path/to/module.py

```

### With `pip`

If you really want this package as one of _your_ package's dependencies, then install via `pip` in the usual way:

```bash

pip install module-cli

```

Which you can then use the CLI:

```bash

$ module-cli -h

usage: module-cli [-h] [-v] [-D] [out]

Bootstrap a single-module python CLI

positional arguments:

  out            File to write to. (default: -)

optional arguments:

  -h, --help     show this help message and exit

  -v, --version  show program's version number and exit

  -D, --debug    run program in debug mode

```

## Installing your CLI

The modules generated by `module-cli` contain a function `cli()`. This function is the one you'll likely want to point to if you intend to turn your module into an installable command-line application.

- **`setup.cfg`**:

  ```ini

  [options.entry_points]

  console_scripts =

      my_cli = my_pkg.my_module:cli

  ```

- **`setup.py`**:

  ```python

  setup(

      entry_points = {

          'console_scripts': ['my_cli=my_pkg.my_module:cli'],

      }

  )

  ```

- **`pyproject.toml`** (poetry):

  ```toml

  [tool.poetry.scripts]

  my_cli = "my_pkg.my_module:cli"

  ```

## Contributing

1. Have or install a recent version of `poetry` (version >= 1.1)

1. Fork the repo

1. Setup a virtual environment (however you prefer)

1. Run `poetry install`

1. Run `pre-commit install`

1. Add your changes (adding/updating tests is always nice too)

1. Commit your changes + push to your fork

1. Open a PR