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

python -m pip install actions-tools

uv add actions-tools

actions-tools

dependencies = ["actions-tools"]

With PyGithub (for GitHub API access).

python -m pip install actions-tools[github]

uv add actions-tools[github]

actions-tools[github]

dependencies = ["actions-tools[github]"]

Install from GitHub.

python -m pip install git+https://github.com/cssnr/actions-tools.git

uv pip install git+https://github.com/cssnr/actions-tools.git

Install from source.

git clone https://github.com/cssnr/actions-tools
python -m pip install actions-tools

Uninstall.

python -m pip uninstall actions-tools

uv remove actions-tools

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