Skip to main content

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

Project description

invoke-toolkit

A set of extensions for rich output, more options in collection/config discovery through entry-points.

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

PyPI - Version PyPI - Python Version


Table of Contents

Features

  • Task discovery by namespace for extendable/composable CLIs
  • Discovery to plain old tasks.py (or any other name)
  • Local tasks discovery from local_tasks.py in the current directory
  • 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

pip install invoke-toolkit

Quick Start

Using Local Tasks

Create a local_tasks.py file in your project directory with your tasks:

from invoke_toolkit import task

@task()
def my_task(ctx):
    """Do something useful"""
    print("Hello from local tasks!")

Then run it with:

intk local.my-task

Local tasks are automatically discovered and added to the local namespace, allowing you to keep project-specific tasks separate from your main task collection.

Development

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

pre-commit install

With uvx:

uvx --with pre-commit-uv pre-commit install

License

invoke-toolkit is distributed under the terms of the MIT license.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

invoke_toolkit-0.0.47.tar.gz (71.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

invoke_toolkit-0.0.47-py3-none-any.whl (57.7 kB view details)

Uploaded Python 3

File details

Details for the file invoke_toolkit-0.0.47.tar.gz.

File metadata

  • Download URL: invoke_toolkit-0.0.47.tar.gz
  • Upload date:
  • Size: 71.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for invoke_toolkit-0.0.47.tar.gz
Algorithm Hash digest
SHA256 5365dd1b541a4aa8dd45cf2ea6eba077c397d241f273e33ae3b3cec4571cc6e2
MD5 6b0d00dcbf2a73b5866c675b2a7f9a05
BLAKE2b-256 e368c09eed9949196e7fc0168a2ec74027847c8ad912646b7857b42b2cb7180f

See more details on using hashes here.

Provenance

The following attestation bundles were made for invoke_toolkit-0.0.47.tar.gz:

Publisher: publish-releases.yaml on D3f0/invoke-toolkit

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file invoke_toolkit-0.0.47-py3-none-any.whl.

File metadata

File hashes

Hashes for invoke_toolkit-0.0.47-py3-none-any.whl
Algorithm Hash digest
SHA256 924a00c2e149edb3c3d7b630e602283d19606328cd2c6047fad5b87daf1e014b
MD5 e0695e7eb3fd9a9caaeba07e36a770af
BLAKE2b-256 9b23b874d495bb75a53fda76933b768657b12df987eddfb1cc9ca8b3af1e971a

See more details on using hashes here.

Provenance

The following attestation bundles were made for invoke_toolkit-0.0.47-py3-none-any.whl:

Publisher: publish-releases.yaml on D3f0/invoke-toolkit

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page