https://github.com/yanglbme/actions-toolkit

🛠 The GitHub ToolKit for developing GitHub Actions in Python | 一个用于开发 GitHub Actions 的工具库
https://github.com/yanglbme/actions-toolkit

actions actions-toolkit github github-actions pypi python

Last synced: 19 days ago
JSON representation

🛠 The GitHub ToolKit for developing GitHub Actions in Python | 一个用于开发 GitHub Actions 的工具库

• Host: GitHub
• URL: https://github.com/yanglbme/actions-toolkit
• Owner: yanglbme
• License: mit
• Created: 2020-11-18T07:03:45.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2024-02-27T08:16:14.000Z (9 months ago)
• Last Synced: 2024-10-17T15:30:52.880Z (28 days ago)
• Topics: actions, actions-toolkit, github, github-actions, pypi, python
• Language: Python
• Homepage: https://yanglbme.github.io/actions-toolkit
• Size: 102 KB
• Stars: 36
• Watchers: 2
• Forks: 6
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# Actions Toolkit

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

[![Downloads](https://pepy.tech/badge/actions-toolkit)](https://pepy.tech/project/actions-toolkit)

[![Pypi Versions](https://img.shields.io/pypi/v/actions-toolkit.svg)](https://pypi.python.org/pypi/actions-toolkit)

[![Contributors](https://img.shields.io/github/contributors/yanglbme/actions-toolkit.svg)](https://github.com/yanglbme/actions-toolkit/graphs/contributors)

## Installation

Action Toolkit is available on PyPI:

```bash

$ python -m pip install actions-toolkit

```

Action Toolkit officially supports Python 3.6+.

## Usage

```python

>>> 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](./docs/core.md) & [github](./docs/github.md).

## 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](./CONTRIBUTION.md) for detailed guidelines.

## License

The scripts and documentation in this project are released under the [MIT License](LICENSE).