python-steer

Name	python-steer JSON
Version	0.2.0 JSON
	download
home_page	None
Summary	A tool to help you write JSON and YAML files from JSON schemas
upload_time	2024-06-09 11:27:22
maintainer	None
docs_url	None
author	José Coelho
requires_python	<4.0,>=3.12
license	None
keywords
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # Steer

A tool to help you write JSON and YAML files from JSON schemas

## Installation

```shell
pip install python-steer
```

## Usage

Let's say you want to build an OpenAPI specification for an API.

1. Download the OpenAPI json schema from [here](https://github.com/OAI/OpenAPI-Specification/blob/main/schemas/v2.0/schema.json)
1. Run steer from the command line

[![asciicast](https://asciinema.org/a/s7k97RgWaRjhokuT1EZ6SgYlw.svg)](https://asciinema.org/a/s7k97RgWaRjhokuT1EZ6SgYlw)

## Roadmap

- [x] Implement prompt for `array` of `string`, `number` and `integer` property type
- [ ] Implement prompt for `array` of `object` property type
- [ ] Implement the `$ref` property type
- [x] Validate string property values with `pattern`
- [ ] Implement prompt for `additionalProperties`
- [ ] Validate `required` fields
- [x] Implement `number` property type
- [ ] Implement `allOf`, `anyOf`, `oneOf` keywords


            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "python-steer",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<4.0,>=3.12",
    "maintainer_email": null,
    "keywords": null,
    "author": "Jos\u00e9 Coelho",
    "author_email": "16445494+jcoelho93@users.noreply.github.com",
    "download_url": "https://files.pythonhosted.org/packages/71/0d/9e6029b067cb4e9fdba2dbca1a70fccf6b74771804f8f44e6795d0031670/python_steer-0.2.0.tar.gz",
    "platform": null,
    "description": "# Steer\n\nA tool to help you write JSON and YAML files from JSON schemas\n\n## Installation\n\n```shell\npip install python-steer\n```\n\n## Usage\n\nLet's say you want to build an OpenAPI specification for an API.\n\n1. Download the OpenAPI json schema from [here](https://github.com/OAI/OpenAPI-Specification/blob/main/schemas/v2.0/schema.json)\n1. Run steer from the command line\n\n[![asciicast](https://asciinema.org/a/s7k97RgWaRjhokuT1EZ6SgYlw.svg)](https://asciinema.org/a/s7k97RgWaRjhokuT1EZ6SgYlw)\n\n## Roadmap\n\n- [x] Implement prompt for `array` of `string`, `number` and `integer` property type\n- [ ] Implement prompt for `array` of `object` property type\n- [ ] Implement the `$ref` property type\n- [x] Validate string property values with `pattern`\n- [ ] Implement prompt for `additionalProperties`\n- [ ] Validate `required` fields\n- [x] Implement `number` property type\n- [ ] Implement `allOf`, `anyOf`, `oneOf` keywords\n\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "A tool to help you write JSON and YAML files from JSON schemas",
    "version": "0.2.0",
    "project_urls": {
        "Bug Tracker": "https://github.com/jcoelho93/steer/issues"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "0e9039492c19c7388a6a0a61685a11c43da5979f005bda5a8e268d10d62c870d",
                "md5": "3ec75503070866a71fefbeeb7519d5f0",
                "sha256": "8905ef9580b163d5cfaeb91b4f147dcd633673f19a6f762fecb468cf63a76e38"
            },
            "downloads": -1,
            "filename": "python_steer-0.2.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "3ec75503070866a71fefbeeb7519d5f0",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0,>=3.12",
            "size": 5464,
            "upload_time": "2024-06-09T11:27:21",
            "upload_time_iso_8601": "2024-06-09T11:27:21.531284Z",
            "url": "https://files.pythonhosted.org/packages/0e/90/39492c19c7388a6a0a61685a11c43da5979f005bda5a8e268d10d62c870d/python_steer-0.2.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "710d9e6029b067cb4e9fdba2dbca1a70fccf6b74771804f8f44e6795d0031670",
                "md5": "687ecbc8d5f7936eef5f3edecb622d89",
                "sha256": "4bc3f94cab2c01db10f91d1220d0ed84ccb0966120b55d05da156cb2968448e0"
            },
            "downloads": -1,
            "filename": "python_steer-0.2.0.tar.gz",
            "has_sig": false,
            "md5_digest": "687ecbc8d5f7936eef5f3edecb622d89",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0,>=3.12",
            "size": 4313,
            "upload_time": "2024-06-09T11:27:22",
            "upload_time_iso_8601": "2024-06-09T11:27:22.680959Z",
            "url": "https://files.pythonhosted.org/packages/71/0d/9e6029b067cb4e9fdba2dbca1a70fccf6b74771804f8f44e6795d0031670/python_steer-0.2.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-06-09 11:27:22",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "jcoelho93",
    "github_project": "steer",
    "github_not_found": true,
    "lcname": "python-steer"
}