{"id":30188651,"url":"https://github.com/ternaus/docstring2json","last_synced_at":"2026-04-22T18:50:54.748Z","repository":{"id":283751326,"uuid":"950315520","full_name":"ternaus/docstring2json","owner":"ternaus","description":"Generate folder with parsed JSON from google docstrings","archived":false,"fork":false,"pushed_at":"2025-05-10T17:43:37.000Z","size":67,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2026-01-13T15:55:43.193Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ternaus.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","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,"zenodo":null},"funding":{"github":"ternaus","patreon":null,"open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"lfx_crowdfunding":null,"custom":null}},"created_at":"2025-03-18T01:08:17.000Z","updated_at":"2025-05-10T17:43:16.000Z","dependencies_parsed_at":"2025-05-07T20:22:37.987Z","dependency_job_id":"8b8e3de0-af1d-4368-a018-3e28335fce1f","html_url":"https://github.com/ternaus/docstring2json","commit_stats":null,"previous_names":["ternaus/google-docstring-2md","ternaus/docstring2json","ternaus/google-docstring-2tsx"],"tags_count":10,"template":false,"template_full_name":null,"purl":"pkg:github/ternaus/docstring2json","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ternaus%2Fdocstring2json","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ternaus%2Fdocstring2json/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ternaus%2Fdocstring2json/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ternaus%2Fdocstring2json/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ternaus","download_url":"https://codeload.github.com/ternaus/docstring2json/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ternaus%2Fdocstring2json/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29916036,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-27T19:37:42.220Z","status":"ssl_error","status_checked_at":"2026-02-27T19:37:41.463Z","response_time":57,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":[],"created_at":"2025-08-12T17:45:27.004Z","updated_at":"2026-02-27T21:43:43.162Z","avatar_url":"https://github.com/ternaus.png","language":"Python","funding_links":["https://github.com/sponsors/ternaus"],"categories":[],"sub_categories":[],"readme":"# Google Docstring to JSON Converter\n\nA tool that converts Python package docstrings to JSON files.\n\n## License\n\nThis software is licensed under a custom license agreement. The Albumentations Team and their official contributors have free access to use this software for their projects. All other users must obtain a paid license.\n\nFor licensing inquiries, please contact:\nVladimir Iglovikov (iglovikov@gmail.com)\n\nSee the [LICENSE](LICENSE) file for full details.\n\n## Features\n\n- Converts Google-style docstrings to JSON format\n- Maintains the original package structure in the output\n- Supports both class and function documentation\n- Handles module-level docstrings\n- Preserves code examples and formatting\n- Supports complex type definitions with interactive display\n\n## Installation\n\n```bash\npip install docstring2json\n```\n\n## Usage\n\n```bash\npython -m src.docstring2json.__main__ --package-name PACKAGE_NAME --output-dir OUTPUT_DIR\n```\n\nor:\n```bash\ndocstring2json --package-name PACKAGE_NAME --output-dir OUTPUT_DIR\n```\n\nThis will:\n1. Import the specified package\n2. Extract docstrings from all classes, functions, and modules\n3. Write JSON files for each module with proper routing\n\n## Output Structure\n\nThe tool creates a directory structure that matches the input package:\n\n```\noutput_dir/\n  module1/\n    file1/\n      data.json\n    file2/\n      data.json\n  module2/\n    submodule/\n      file2/\n        data.json\n```\n\nEach `data.json` file contains:\n- Module name and description\n- Parameter descriptions with type information\n- Return values and exceptions with proper formatting\n- Code examples with syntax highlighting\n- References and links to related documentation\n\n## Development\n\n```bash\n# Install dependencies\npip install -e .\n\n# Run tests\npytest\n\n# Run pre-commit hooks\npre-commit run --all-files\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fternaus%2Fdocstring2json","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fternaus%2Fdocstring2json","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fternaus%2Fdocstring2json/lists"}