Get Started¶

A Typed Python GitHub Actions Tookit similar to actions/toolkit .

To get started install the tools and view the usage.

If you run into any issues, support is available.

Install¶

From PyPI: https://pypi.org/p/actions-tools
GitHub: https://github.com/cssnr/actions-tools

uv tool install actions-tools

uv add --dev actions-tools

pip install actions-tools

pip install --group dev actions-tools

Upgrade.

uv tool upgrade actions-tools

uv sync --upgrade-package actions-tools

pip install -U actions-tools

pip install -U actions-tools

Uninstall.

uv tool uninstall actions-tools

uv remove --group dev actions-tools

pip uninstall actions-tools

pip uninstall actions-tools

Next, see the Usage guide.

Quick Start¶

Install the tools.

pip install actions-tools

Use the modules.

from actions import core, context

token = core.get_input("token", True)
g = core.get_github(token)  # (1)!
repo = g.get_repo(context.repository)
core.info(f"repo.name: {repo.name}")

event = core.get_event()
core.info(event["repository"])

core.set_output("repo", repo.name)
core.summary.add_raw("🚀 We Did It!")

1. To use get_github install with the github extra:

   python -m pip install actions-tools[github]
   

Make sure to view the full Usage guide.

View the Usage Guide