actions-python-core

Name	actions-python-core JSON
Version	0.1.3 JSON
	download
home_page
Summary	Actions core lib
upload_time	2023-10-08 17:40:08
maintainer
docs_url	None
author
requires_python	>=3.9
license
keywords	action ci github
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # `actions-python-core`

> Core functions for setting results, logging, registering secrets and exporting variables across actions

## Usage

### Import the package

```python
from actions import core
```

#### Inputs/Outputs

Action inputs can be read with `get_input` which returns a `str` or `get_boolean_input` which parses a boolean based on the [yaml 1.2 specification](https://yaml.org/spec/1.2/spec.html#id2804923). If `required` set to be false, the input should have a default value in `action.yml`.

Outputs can be set with `set_output` which makes them available to be mapped into inputs of other actions to ensure they are decoupled.

```python
my_input = core.get_input("input_name", required=True)
my_boolean_input = core.get_boolean_input("boolean_input_name", required=True)
my_multiline_input = core.get_multiline_input("multiline_input_name", required=True)

core.set_output("output_key", "output_value")
```

#### TBD

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "actions-python-core",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": "",
    "keywords": "action,ci,github",
    "author": "",
    "author_email": "sudosubin <sudosubin@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/22/02/843cfcf2d371663be207d240e7534a3e75f13c7940803e0523da0c05040f/actions_python_core-0.1.3.tar.gz",
    "platform": null,
    "description": "# `actions-python-core`\n\n> Core functions for setting results, logging, registering secrets and exporting variables across actions\n\n## Usage\n\n### Import the package\n\n```python\nfrom actions import core\n```\n\n#### Inputs/Outputs\n\nAction inputs can be read with `get_input` which returns a `str` or `get_boolean_input` which parses a boolean based on the [yaml 1.2 specification](https://yaml.org/spec/1.2/spec.html#id2804923). If `required` set to be false, the input should have a default value in `action.yml`.\n\nOutputs can be set with `set_output` which makes them available to be mapped into inputs of other actions to ensure they are decoupled.\n\n```python\nmy_input = core.get_input(\"input_name\", required=True)\nmy_boolean_input = core.get_boolean_input(\"boolean_input_name\", required=True)\nmy_multiline_input = core.get_multiline_input(\"multiline_input_name\", required=True)\n\ncore.set_output(\"output_key\", \"output_value\")\n```\n\n#### TBD\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "Actions core lib",
    "version": "0.1.3",
    "project_urls": {
        "Homepage": "https://github.com/actions-python/toolkit"
    },
    "split_keywords": [
        "action",
        "ci",
        "github"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "25c7b50f151ba88f864c5075b171db8c40597762746180a031b935a9080e3b9b",
                "md5": "6b84d4a0df7fb0ad13adfcc886c9e803",
                "sha256": "3a12a8788ddbcd873eb6fba4ec6d5d96bab89ff04bfbdcb8c4e77032e4a8b134"
            },
            "downloads": -1,
            "filename": "actions_python_core-0.1.3-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "6b84d4a0df7fb0ad13adfcc886c9e803",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 11809,
            "upload_time": "2023-10-08T17:40:07",
            "upload_time_iso_8601": "2023-10-08T17:40:07.470766Z",
            "url": "https://files.pythonhosted.org/packages/25/c7/b50f151ba88f864c5075b171db8c40597762746180a031b935a9080e3b9b/actions_python_core-0.1.3-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "2202843cfcf2d371663be207d240e7534a3e75f13c7940803e0523da0c05040f",
                "md5": "7b5653fd85444fd467fa6d3b65482c55",
                "sha256": "1f6d818393d79e0a80ab5e71e31a5ce7ab651c196fa6f32fbe5fe9305163ac86"
            },
            "downloads": -1,
            "filename": "actions_python_core-0.1.3.tar.gz",
            "has_sig": false,
            "md5_digest": "7b5653fd85444fd467fa6d3b65482c55",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 10586,
            "upload_time": "2023-10-08T17:40:08",
            "upload_time_iso_8601": "2023-10-08T17:40:08.991389Z",
            "url": "https://files.pythonhosted.org/packages/22/02/843cfcf2d371663be207d240e7534a3e75f13c7940803e0523da0c05040f/actions_python_core-0.1.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-10-08 17:40:08",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "actions-python",
    "github_project": "toolkit",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "actions-python-core"
}