🛠 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.
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 docs.
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
Release history Release notifications | RSS feed
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.9.tar.gz
(11.1 kB
view hashes)
Built Distribution
Close
Hashes for actions_toolkit-0.1.9-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 418d6ceccc0c1393fc85f1d5e1b1ac83f882e57d15502e13a338ed7fcc957dc0 |
|
MD5 | a93488090acdb1dd10d6e5254ddcde2e |
|
BLAKE2b-256 | 43bd70c7cae2fd997c0bd5d999f844beba5cf3fd45f12dd6321f80b23c782f6f |