actions-toolkit

What it is and what it does

Actions Toolkit is a Python SDK designed to simplify the creation of GitHub Actions. It wraps common GitHub Actions patterns—reading environment-based inputs, writing structured log output (error, info, warning), and setting action status—into a straightforward API. The package depends on requests and PyGithub to handle HTTP communication and GitHub API interactions.

Typical use involves importing the core module to read action inputs from environment variables, perform work, and report results back to GitHub's action runner using standardized output formats. It's intended for developers writing custom GitHub Actions in Python rather than for general-purpose GitHub API clients.

Use it for:

• Read inputs from a GitHub Actions workflow and log structured messages back to the runner.
• Set action status and emit error messages that GitHub displays in the workflow UI.
• Build a custom GitHub Action that needs to interact with the GitHub API via PyGithub.
• Automate CI/CD tasks that require reading workflow context and reporting results to GitHub.

Worth the install?

AI-flagged interpretation of the facts on this page — verify before relying

Provides a Python SDK for building GitHub Actions with utilities for reading inputs, writing outputs, and interacting with the GitHub API.

Yes, if you are writing a GitHub Action in Python and need a lightweight SDK for input/output handling. The low install friction and permissive license are favorable. However, the dormant maintenance status (last release 2022-10-28) means you should verify that it works with your target Python version and GitHub Actions environment before committing to production use.

Install

actions-toolkit on PyPI

pip install actions-toolkit

uv add actions-toolkit

poetry add actions-toolkit

Installing actions-toolkit

Before you install

Low install friction with only two runtime dependencies (requests and PyGithub). Maintenance is dormant—last release was 2022-10-28 and last commit 2024-02-27—so expect no active bug fixes or feature updates.

License in practice

MIT license is permissive and poses no significant restrictions on use, modification, or distribution.

Quickstart

import os
from actions_toolkit import core
os.environ['INPUT_NAME'] = 'Actions Toolkit'
core.get_input('name', required=True)
core.error('Something went wrong.')
core.info('Run successfully.')

Requires Python 3.6 or later; designed for use within GitHub Actions environments.

Verify before relying

• Whether the package works reliably with GitHub Actions environments beyond the tested Python versions.
• Whether dormant status means the package is stable enough for production use or if it has unresolved issues.

Package facts

Evidence: actions_toolkit-0.1.15-py3-none-any.whl

Tags

More Build Tools packages