Skip to main content

🛠 The GitHub ToolKit for developing GitHub Actions in Python.

Project description

Actions Toolkit

The GitHub Actions ToolKit provides a set of packages to make creating actions easier in Python.

Downloads Supported Versions Pypi Versions Contributors FOSSA Status

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

Installing Actions Toolkit and Supported Versions

Action Toolkit is available on PyPI:

$ python -m pip install actions-toolkit

Action Toolkit officially supports Python 3.6+.

Packages

  • actions.core: Provides functions for inputs, outputs, results, logging, secrets and variables. Read more here.
  • actions.exec: Provides functions to exec cli tools and process output.
  • actions.glob: Provides functions to search for files matching glob patterns.
  • actions.io: Provides disk i/o functions like cp, mv, rmRF, which etc.
  • actions.tool-cache: Provides functions for downloading and caching tools. e.g. setup-* actions.
  • actions.github: Provides an Octokit client hydrated with the context that the current action is being run in.
  • actions.artifact: Provides functions to interact with actions artifacts.
  • actions.cache: Provides functions to cache dependencies and build outputs to improve workflow execution time.

Contributing

We welcome contributions.

License

The scripts and documentation in this project are released under the MIT License.

FOSSA Status

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

actions-toolkit-0.1.0.tar.gz (9.3 kB view hashes)

Uploaded Source

Built Distribution

actions_toolkit-0.1.0-py3-none-any.whl (11.0 kB view hashes)

Uploaded Python 3

Supported by

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