aws-step-functions-pydantic

Name	aws-step-functions-pydantic JSON
Version	0.0.4 JSON
	download
home_page	https://github.com/lmmx/aws-step-functions-pydantic
Summary	Pydantic models for AWS step functions
upload_time	2023-08-02 11:18:34
maintainer	Louis Maddox
docs_url	None
author	Louis Maddox
requires_python	>=3.10
license	MIT
keywords
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # aws-step-functions-pydantic

[![CI Status](https://github.com/lmmx/aws-step-functions-pydantic/actions/workflows/master.yml/badge.svg)](https://github.com/lmmx/aws-step-functions-pydantic/actions/workflows/master.yml)
[![Coverage](https://codecov.io/gh/lmmx/aws-step-functions-pydantic/branch/master/graph/badge.svg)](https://codecov.io/github/lmmx/aws-step-functions-pydantic)
[![Checked with mypy](http://www.mypy-lang.org/static/mypy_badge.svg)](http://mypy-lang.org)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)

Pydantic models for AWS step functions

## Usage

### From Step Function ARN

Use the `from_arn()` class constructor

```py
from aws_sfn_pydantic import StateMachine

sfn = StateMachine.from_arn(state_machine_arn="...")
```

### From JSON

Use the `model_validate_json()` class constructor (Pydantic v2 builtin)

```py
from aws_sfn_pydantic import StateMachine

sfn = StateMachine.model_validate_json("...")
```

### To YAML

Use the `to_yaml()` class constructor, which accepts:

- `indent` (default: 2)
- `level` (default: 0)

```py
print(sfn.model_to_yaml())
```

## Requires

- Python 3.10+

## Installation

```sh
pip install aws-step-functions-pydantic
```

> _aws-step-functions-pydantic_ is available from [PyPI](https://pypi.org/project/aws-step-functions-pydantic), and
> the code is on [GitHub](https://github.com/lmmx/aws-step-functions-pydantic)

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/lmmx/aws-step-functions-pydantic",
    "name": "aws-step-functions-pydantic",
    "maintainer": "Louis Maddox",
    "docs_url": null,
    "requires_python": ">=3.10",
    "maintainer_email": "louismmx@gmail.com",
    "keywords": "",
    "author": "Louis Maddox",
    "author_email": "louismmx@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/52/ea/650f23118ee0d7119151e6eaa19d0a0e2dd2f1be2d4b622652d19806d2e1/aws-step-functions-pydantic-0.0.4.tar.gz",
    "platform": null,
    "description": "# aws-step-functions-pydantic\n\n[![CI Status](https://github.com/lmmx/aws-step-functions-pydantic/actions/workflows/master.yml/badge.svg)](https://github.com/lmmx/aws-step-functions-pydantic/actions/workflows/master.yml)\n[![Coverage](https://codecov.io/gh/lmmx/aws-step-functions-pydantic/branch/master/graph/badge.svg)](https://codecov.io/github/lmmx/aws-step-functions-pydantic)\n[![Checked with mypy](http://www.mypy-lang.org/static/mypy_badge.svg)](http://mypy-lang.org)\n[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)\n\nPydantic models for AWS step functions\n\n## Usage\n\n### From Step Function ARN\n\nUse the `from_arn()` class constructor\n\n```py\nfrom aws_sfn_pydantic import StateMachine\n\nsfn = StateMachine.from_arn(state_machine_arn=\"...\")\n```\n\n### From JSON\n\nUse the `model_validate_json()` class constructor (Pydantic v2 builtin)\n\n```py\nfrom aws_sfn_pydantic import StateMachine\n\nsfn = StateMachine.model_validate_json(\"...\")\n```\n\n### To YAML\n\nUse the `to_yaml()` class constructor, which accepts:\n\n- `indent` (default: 2)\n- `level` (default: 0)\n\n```py\nprint(sfn.model_to_yaml())\n```\n\n## Requires\n\n- Python 3.10+\n\n## Installation\n\n```sh\npip install aws-step-functions-pydantic\n```\n\n> _aws-step-functions-pydantic_ is available from [PyPI](https://pypi.org/project/aws-step-functions-pydantic), and\n> the code is on [GitHub](https://github.com/lmmx/aws-step-functions-pydantic)\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Pydantic models for AWS step functions",
    "version": "0.0.4",
    "project_urls": {
        "Bug Tracker": "https://github.com/lmmx/aws-step-functions-pydantic/issues",
        "Documentation": "https://aws-step-functions-pydantic.readthedocs.io/",
        "Homepage": "https://github.com/lmmx/aws-step-functions-pydantic",
        "Source Code": "https://github.com/lmmx/aws-step-functions-pydantic"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "5838801685518d11381d047efdbbbf4da5c3d689708409276e2699188f724439",
                "md5": "b2b0963090e5cac66ee3081e3fef4849",
                "sha256": "9b7126f86dc1a5d47f42914040a8a7985f3dce3fd6e8c9d045bd6d615d812dac"
            },
            "downloads": -1,
            "filename": "aws_step_functions_pydantic-0.0.4-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "b2b0963090e5cac66ee3081e3fef4849",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10",
            "size": 7569,
            "upload_time": "2023-08-02T11:18:33",
            "upload_time_iso_8601": "2023-08-02T11:18:33.318116Z",
            "url": "https://files.pythonhosted.org/packages/58/38/801685518d11381d047efdbbbf4da5c3d689708409276e2699188f724439/aws_step_functions_pydantic-0.0.4-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "52ea650f23118ee0d7119151e6eaa19d0a0e2dd2f1be2d4b622652d19806d2e1",
                "md5": "3035c6960f4f450a43546d0fcfffbc27",
                "sha256": "7f85a18df7557f8ff6964c73acb556f300bb1cf53573ea792b26eebc91c07a80"
            },
            "downloads": -1,
            "filename": "aws-step-functions-pydantic-0.0.4.tar.gz",
            "has_sig": false,
            "md5_digest": "3035c6960f4f450a43546d0fcfffbc27",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10",
            "size": 15630,
            "upload_time": "2023-08-02T11:18:34",
            "upload_time_iso_8601": "2023-08-02T11:18:34.743078Z",
            "url": "https://files.pythonhosted.org/packages/52/ea/650f23118ee0d7119151e6eaa19d0a0e2dd2f1be2d4b622652d19806d2e1/aws-step-functions-pydantic-0.0.4.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-08-02 11:18:34",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "lmmx",
    "github_project": "aws-step-functions-pydantic",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [],
    "tox": true,
    "lcname": "aws-step-functions-pydantic"
}