{"id":15012920,"url":"https://github.com/jcoelho93/steer","last_synced_at":"2025-04-12T03:31:55.202Z","repository":{"id":243538655,"uuid":"798455239","full_name":"jcoelho93/steer","owner":"jcoelho93","description":"A CLI tool to interactively generate JSON and YAML files from JSON schemas","archived":false,"fork":false,"pushed_at":"2024-06-23T14:13:42.000Z","size":129,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-03-21T07:49:10.349Z","etag":null,"topics":["json","json-schema","steer","yaml"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jcoelho93.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-05-09T20:12:55.000Z","updated_at":"2025-02-18T10:40:57.000Z","dependencies_parsed_at":"2024-06-28T08:48:22.526Z","dependency_job_id":null,"html_url":"https://github.com/jcoelho93/steer","commit_stats":{"total_commits":34,"total_committers":1,"mean_commits":34.0,"dds":0.0,"last_synced_commit":"2a63ad4b7c07499f3bf700c31b97215781760978"},"previous_names":["jcoelho93/steer"],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jcoelho93%2Fsteer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jcoelho93%2Fsteer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jcoelho93%2Fsteer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jcoelho93%2Fsteer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jcoelho93","download_url":"https://codeload.github.com/jcoelho93/steer/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248512789,"owners_count":21116680,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["json","json-schema","steer","yaml"],"created_at":"2024-09-24T19:43:24.799Z","updated_at":"2025-04-12T03:31:54.908Z","avatar_url":"https://github.com/jcoelho93.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Steer\n\n![PyPI - Version](https://img.shields.io/pypi/v/python-steer)\n![PyPI - Python Version](https://img.shields.io/pypi/pyversions/python-steer)\n![PyPI - Downloads](https://img.shields.io/pypi/dm/python-steer)\n[![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=jcoelho93_steer\u0026metric=security_rating)](https://sonarcloud.io/summary/new_code?id=jcoelho93_steer)\n[![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=jcoelho93_steer\u0026metric=vulnerabilities)](https://sonarcloud.io/summary/new_code?id=jcoelho93_steer)\n[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=jcoelho93_steer\u0026metric=coverage)](https://sonarcloud.io/summary/new_code?id=jcoelho93_steer)\n\nA CLI tool to interactively generate 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\nThis is still very much in alpha. There is still a lot of work to implement all the json schema specifications.\nIt is usable for a few use cases without major issues.\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 object with `additionalProperties`\n- [ ] Validate `required` fields\n- [x] Implement `number` property type\n- [ ] Implement `allOf`, `anyOf`, `oneOf` keywords\n\n## Use cases\n\nHere are some examples where this tool might be useful.\n\n### Helm chart values\n\nIf you're deploying to Kubernetes using a helm chart, instead of going through the charts documentation to set your values, you could use this tool to interactively set up the `values.yaml` file for the chart.\n\n```shell\nsteer chart.schema.json --output-type yaml --output-file values.yaml\n...\n```\n\n### OpenAPI Specification\n\nWhen building an API with the OpenAPI specification you can use this tool to design your API's endpoints.\n\n```shell\nsteer openapi.schema.json --output-type yaml --output-file rest-api.yaml\n...\n```\n\n### Writing CICD configuration\n\nThis can help you define your CICD configuration file for different systems like GitHub Actions, CircleCI, GitLab CI, etc.\n\n```shell\nsteer circleci.schema.json --output-type yaml --output-file config.yml\n...\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjcoelho93%2Fsteer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjcoelho93%2Fsteer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjcoelho93%2Fsteer/lists"}