{"id":17080543,"url":"https://github.com/kylef/draughtsman","last_synced_at":"2025-04-12T21:11:01.907Z","repository":{"id":57423951,"uuid":"90168085","full_name":"kylef/draughtsman","owner":"kylef","description":"API Blueprint Parser for Python 3","archived":false,"fork":false,"pushed_at":"2020-04-04T13:53:19.000Z","size":20,"stargazers_count":22,"open_issues_count":1,"forks_count":3,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-26T15:21:15.011Z","etag":null,"topics":["api-blueprint"],"latest_commit_sha":null,"homepage":"https://apiblueprint.org","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/kylef.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-05-03T16:05:07.000Z","updated_at":"2024-11-28T16:33:19.000Z","dependencies_parsed_at":"2022-08-27T17:00:26.700Z","dependency_job_id":null,"html_url":"https://github.com/kylef/draughtsman","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kylef%2Fdraughtsman","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kylef%2Fdraughtsman/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kylef%2Fdraughtsman/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kylef%2Fdraughtsman/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kylef","download_url":"https://codeload.github.com/kylef/draughtsman/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248631676,"owners_count":21136562,"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":["api-blueprint"],"created_at":"2024-10-14T12:45:19.848Z","updated_at":"2025-04-12T21:11:01.875Z","avatar_url":"https://github.com/kylef.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Draughtsman\n\n[API Blueprint](https://apiblueprint.org) Parser for Python 3. Draughtsman is a\nPython binding for the API Blueprint parser\n[drafter](https://github.com/apiaryio/drafter).\n\n## Installation\n\n```shell\n$ pip install draughtsman\n```\n\nDraughtsman requires the drafter library installed onto your system. Consult\nthe [drafter installation](https://github.com/apiaryio/drafter#install)\ninstructions for further information. Using Homebrew on macOS, Drafter can be\ninstalled via:\n\n```shell\n$ brew install drafter\n```\n\n## Usage\n\n```python\n\u003e\u003e\u003e from draughtsman import parse\n\u003e\u003e\u003e\n\u003e\u003e\u003e parse_result = parse('# My API')\n\u003e\u003e\u003e parse_result.api.title.defract\n'My API'\n```\n\nDraughtsman provides a `parse` function which returns a Refract\n[ParseResult](http://python-refract.readthedocs.io/en/latest/apielements.html#parseresult).\nSee [Python Refract](http://python-refract.readthedocs.io/en/latest/) for more\ninformation interacting with the parse result.\n\n### CLI\n\nDraughtsman provides a convenience shell to parse an API Blueprint and interact\nwith the parse result.\n\n```shell\n$ python -m draughtsman example.apib\n\u003e\u003e\u003e parse_result\n\u003cParseResult content=[\u003cCategory content=[]\u003e]\u003e\n\u003e\u003e\u003e parse_result.annotations\n[]\n\u003e\u003e\u003e parse_result.api.title\n\u003cString content='My API'\u003e\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkylef%2Fdraughtsman","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkylef%2Fdraughtsman","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkylef%2Fdraughtsman/lists"}