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.
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.pyin the current directory - Integration with stand alone binaries for specific tasks
- Task result caching with TTL support via
diskcache(optional) - Future Download binaries
Do I need this package
If you have...
- Used
invokefor a while and... - Have a large
tasks.pythat needs to be modularized - Have a lot of copy/pasted code in multiple
tasks.pyacross 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.
Using Task Caching
Cache expensive task results with the cache parameter:
from invoke_toolkit import task
# Simple caching (no expiration)
@task(cache=True)
def expensive_task(ctx, param: str) -> str:
"""Results are cached across invocations."""
return do_expensive_computation(param)
# Caching with TTL (1 hour)
@task(cache={"ttl": 3600})
def cached_task(ctx, name: str) -> dict:
"""Results cached for 1 hour."""
return fetch_data(name)
# Caching with ignored arguments
@task(cache={"ttl": 600, "ignore_args": ["verbose"]})
def cached_with_options(ctx, query: str, verbose: bool = False) -> list:
"""Cache key ignores verbose flag."""
return search(query, verbose=verbose)
Cache features:
- Cache location is computed from git repository root + platformdirs
- Debug logging (
-dflag) shows cache hits/misses - Graceful degradation when
diskcacheis not installed
To enable caching, install with the cache extra:
pip install invoke-toolkit[cache]
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.
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file invoke_toolkit-0.0.63.tar.gz.
File metadata
- Download URL: invoke_toolkit-0.0.63.tar.gz
- Upload date:
- Size: 160.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
49ced3627020bf4ffb6a3bad0faf64f2a8919de0d8eceffa4ec5425555d8aef4
|
|
| MD5 |
bfbaea511594c9851a88077f3ade9572
|
|
| BLAKE2b-256 |
e8b16145ef7e24ec6862e5f0712f98af29273a4cfe3af973862d4d3304bf708b
|
Provenance
The following attestation bundles were made for invoke_toolkit-0.0.63.tar.gz:
Publisher:
publish-releases.yaml on D3f0/invoke-toolkit
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
invoke_toolkit-0.0.63.tar.gz -
Subject digest:
49ced3627020bf4ffb6a3bad0faf64f2a8919de0d8eceffa4ec5425555d8aef4 - Sigstore transparency entry: 2114391769
- Sigstore integration time:
-
Permalink:
D3f0/invoke-toolkit@ee4db400c97c2bcbc9c4e1ca86d90e032e2c4ec3 -
Branch / Tag:
refs/tags/v0.0.63 - Owner: https://github.com/D3f0
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish-releases.yaml@ee4db400c97c2bcbc9c4e1ca86d90e032e2c4ec3 -
Trigger Event:
release
-
Statement type:
File details
Details for the file invoke_toolkit-0.0.63-py3-none-any.whl.
File metadata
- Download URL: invoke_toolkit-0.0.63-py3-none-any.whl
- Upload date:
- Size: 102.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
bfda1877a0942fff3d73e4921ef9037d6d167acc41ce4b9b85b93f113bdc58db
|
|
| MD5 |
9984d6a0cceb8c6430198d94be9a8ec0
|
|
| BLAKE2b-256 |
3f6b8c96cc1fe62b57d104d80a1283df7c98159c3dcccd449d17db38ca47ff94
|
Provenance
The following attestation bundles were made for invoke_toolkit-0.0.63-py3-none-any.whl:
Publisher:
publish-releases.yaml on D3f0/invoke-toolkit
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
invoke_toolkit-0.0.63-py3-none-any.whl -
Subject digest:
bfda1877a0942fff3d73e4921ef9037d6d167acc41ce4b9b85b93f113bdc58db - Sigstore transparency entry: 2114391838
- Sigstore integration time:
-
Permalink:
D3f0/invoke-toolkit@ee4db400c97c2bcbc9c4e1ca86d90e032e2c4ec3 -
Branch / Tag:
refs/tags/v0.0.63 - Owner: https://github.com/D3f0
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish-releases.yaml@ee4db400c97c2bcbc9c4e1ca86d90e032e2c4ec3 -
Trigger Event:
release
-
Statement type:
