https://github.com/d3f0/invoke-toolkit

A set of API extension to Invoke API to enhance CLI writing
https://github.com/d3f0/invoke-toolkit

Last synced: 1 day ago
JSON representation

A set of API extension to Invoke API to enhance CLI writing

• Host: GitHub
• URL: https://github.com/d3f0/invoke-toolkit
• Owner: D3f0
• License: mit
• Created: 2024-08-02T08:18:04.000Z (5 months ago)
• Default Branch: main
• Last Pushed: 2024-09-27T13:47:03.000Z (3 months ago)
• Last Synced: 2024-11-07T07:52:52.924Z (about 2 months ago)
• Language: Python
• Size: 52.7 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# invoke-toolkit

A set of extended APIs for PyInvoke for composable scripts, plugins and richer output.

This extends the Collection from Invoke so it can create automatically collections.

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

[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/invoke-toolkit.svg)](https://pypi.org/project/invoke-toolkit)

-----

## Table of Contents

- [invoke-toolkit](#invoke-toolkit)

  - [Table of Contents](#table-of-contents)

  - [Features](#features)

  - [Do I need this package](#do-i-need-this-package)

  - [Installation](#installation)

  - [Development](#development)

  - [License](#license)

## Features

- Task discovery by namespace for extendable/composable CLIs

- Discovery to *plain old* tasks.py (or any other name)

- Integration with stand alone binaries for specific tasks

- **Future** Download binaries

## Do I need this package

If you have...

- Used `invoke` for a while and...

- Have a large `tasks.py` that needs to be modularized

- Have a lot of copy/pasted code in multiple `tasks.py` across multiple repos.

- Have exceeded the approach of a repository cloned as `~/tasks/` with more .py files that you want to manage.

- Or you want to combine various tasks defined in multiple directories

- You want to create a zipped (shiv) redistribute script for container environments

  like Kubernetes based CI environments with only requiring the Python interpreter.

## Installation

```console

pip install invoke-toolkit

```

## Development

This project utilizes the `pre-commit` framework, make sure you run:

`pre-commit install`

## License

`invoke-toolkit` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.