Skip to main content

🛠 The GitHub ToolKit for developing GitHub Actions in Python.

Project description

Actions Toolkit

The GitHub Actions ToolKit provides an SDK to make creating actions easier in Python.

Downloads Supported Versions Pypi Versions Contributors

Installation

Action Toolkit is available on PyPI:

$ python -m pip install actions-toolkit

Action Toolkit officially supports Python 3.6+.

Usage

>>> 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.

For more examples and API documentation, please see the core & github.

Contributing

Contributions are always welcomed!

Here are the workflow for contributors:

  • Fork to your own
  • Clone fork to local repository
  • Create a new branch and work on it
  • Keep your branch in sync
  • Commit your changes (make sure your commit message concise)
  • Push your commits to your forked repository
  • Create a pull request

Please refer to CONTRIBUTING for detailed guidelines.

License

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

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.13.tar.gz (12.4 kB view hashes)

Uploaded Source

Built Distribution

actions_toolkit-0.1.13-py3-none-any.whl (14.2 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