| Name | astdoc JSON |
| Version |
1.3.1
JSON |
| download |
| home_page | None |
| Summary | A lightweight Python library for parsing AST and extracting docstring information. Automatically generate documentation from Python source code by analyzing abstract syntax trees and docstrings. |
| upload_time | 2025-07-26 22:30:06 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10 |
| license | MIT License Copyright (c) 2020-present daizutabi <daizutabi@gmail.com> Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
api-documentation
ast
code-analysis
code-documentation
docstring
documentation
documentation-generator
google-style
mkdocs
numpy-style
parser
python
sphinx
static-analysis
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# astdoc
[![PyPI Version][pypi-v-image]][pypi-v-link]
[![Build Status][GHAction-image]][GHAction-link]
[![Coverage Status][codecov-image]][codecov-link]
[![Documentation Status][docs-image]][docs-link]
[![Python Version][python-v-image]][python-v-link]
A lightweight Python library for parsing and analyzing abstract
syntax trees (AST) and extracting docstring information.
Designed to facilitate the documentation process, astdoc provides
tools for developers to easily access, manipulate, and generate
documentation from Python code.
## Features
- **Smart Docstring Parsing**: Automatically extracts and parses docstrings
in Google and NumPy styles
- **AST Analysis**: Deep understanding of Python code structure through AST traversal
- **Namespace Support**: Handles namespace packages and complex module structures
- **Type-Aware**: Built-in support for type hints and annotations
- **Modern Python**: Compatible with Python 3.10+ including the latest 3.13
- **Lightweight**: Minimal dependencies, focusing on core functionality
## Installation
```bash
pip install astdoc
```
## Documentation
For detailed documentation, visit
[https://daizutabi.github.io/astdoc/](https://daizutabi.github.io/astdoc/)
## Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE)
file for details.
<!-- Badges -->
[pypi-v-image]: https://img.shields.io/pypi/v/astdoc.svg
[pypi-v-link]: https://pypi.org/project/astdoc/
[GHAction-image]: https://github.com/daizutabi/astdoc/actions/workflows/ci.yaml/badge.svg?branch=main&event=push
[GHAction-link]: https://github.com/daizutabi/astdoc/actions?query=event%3Apush+branch%3Amain
[codecov-image]: https://codecov.io/github/daizutabi/astdoc/coverage.svg?branch=main
[codecov-link]: https://codecov.io/github/daizutabi/astdoc?branch=main
[docs-image]: https://img.shields.io/badge/docs-latest-blue.svg
[docs-link]: https://daizutabi.github.io/astdoc/
[python-v-image]: https://img.shields.io/pypi/pyversions/astdoc.svg
[python-v-link]: https://pypi.org/project/astdoc
Raw data
{
"_id": null,
"home_page": null,
"name": "astdoc",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "api-documentation, ast, code-analysis, code-documentation, docstring, documentation, documentation-generator, google-style, mkdocs, numpy-style, parser, python, sphinx, static-analysis",
"author": null,
"author_email": "daizutabi <daizutabi@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/e3/cc/44a0ccaafdb65714bd159b67ccdeae7caab782fe6a65bb2193c220d6ce5e/astdoc-1.3.1.tar.gz",
"platform": null,
"description": "# astdoc\n\n[![PyPI Version][pypi-v-image]][pypi-v-link]\n[![Build Status][GHAction-image]][GHAction-link]\n[![Coverage Status][codecov-image]][codecov-link]\n[![Documentation Status][docs-image]][docs-link]\n[![Python Version][python-v-image]][python-v-link]\n\nA lightweight Python library for parsing and analyzing abstract\nsyntax trees (AST) and extracting docstring information.\nDesigned to facilitate the documentation process, astdoc provides\ntools for developers to easily access, manipulate, and generate\ndocumentation from Python code.\n\n## Features\n\n- **Smart Docstring Parsing**: Automatically extracts and parses docstrings\n in Google and NumPy styles\n- **AST Analysis**: Deep understanding of Python code structure through AST traversal\n- **Namespace Support**: Handles namespace packages and complex module structures\n- **Type-Aware**: Built-in support for type hints and annotations\n- **Modern Python**: Compatible with Python 3.10+ including the latest 3.13\n- **Lightweight**: Minimal dependencies, focusing on core functionality\n\n## Installation\n\n```bash\npip install astdoc\n```\n\n## Documentation\n\nFor detailed documentation, visit\n[https://daizutabi.github.io/astdoc/](https://daizutabi.github.io/astdoc/)\n\n## Contributing\n\nContributions are welcome! Please feel free to submit a Pull Request.\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE)\nfile for details.\n\n<!-- Badges -->\n[pypi-v-image]: https://img.shields.io/pypi/v/astdoc.svg\n[pypi-v-link]: https://pypi.org/project/astdoc/\n[GHAction-image]: https://github.com/daizutabi/astdoc/actions/workflows/ci.yaml/badge.svg?branch=main&event=push\n[GHAction-link]: https://github.com/daizutabi/astdoc/actions?query=event%3Apush+branch%3Amain\n[codecov-image]: https://codecov.io/github/daizutabi/astdoc/coverage.svg?branch=main\n[codecov-link]: https://codecov.io/github/daizutabi/astdoc?branch=main\n[docs-image]: https://img.shields.io/badge/docs-latest-blue.svg\n[docs-link]: https://daizutabi.github.io/astdoc/\n[python-v-image]: https://img.shields.io/pypi/pyversions/astdoc.svg\n[python-v-link]: https://pypi.org/project/astdoc\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2020-present daizutabi <daizutabi@gmail.com> Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
"summary": "A lightweight Python library for parsing AST and extracting docstring information. Automatically generate documentation from Python source code by analyzing abstract syntax trees and docstrings.",
"version": "1.3.1",
"project_urls": {
"Changelog": "https://github.com/daizutabi/astdoc/blob/main/CHANGELOG.md",
"Documentation": "https://daizutabi.github.io/astdoc/",
"Issues": "https://github.com/daizutabi/astdoc/issues",
"Source": "https://github.com/daizutabi/astdoc"
},
"split_keywords": [
"api-documentation",
" ast",
" code-analysis",
" code-documentation",
" docstring",
" documentation",
" documentation-generator",
" google-style",
" mkdocs",
" numpy-style",
" parser",
" python",
" sphinx",
" static-analysis"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "14b41bc0c11102d22d5332dc6dd7ae55edfbe3903b6104a6271adecb1849a519",
"md5": "7ad4e734a456d1eb191cabe651002c7c",
"sha256": "89f4a10694dd457e504bee4747cb79ec61ff41e022e09b345b36e3f7513d72fd"
},
"downloads": -1,
"filename": "astdoc-1.3.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7ad4e734a456d1eb191cabe651002c7c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 43589,
"upload_time": "2025-07-26T22:30:05",
"upload_time_iso_8601": "2025-07-26T22:30:05.786400Z",
"url": "https://files.pythonhosted.org/packages/14/b4/1bc0c11102d22d5332dc6dd7ae55edfbe3903b6104a6271adecb1849a519/astdoc-1.3.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "e3cc44a0ccaafdb65714bd159b67ccdeae7caab782fe6a65bb2193c220d6ce5e",
"md5": "f7de31ad9a2913acb1272ea9c12063b8",
"sha256": "ea79a3542ba5cb3bdf56c0c7979276770b30b453c0eb3eb9a0419dfcda39a9d8"
},
"downloads": -1,
"filename": "astdoc-1.3.1.tar.gz",
"has_sig": false,
"md5_digest": "f7de31ad9a2913acb1272ea9c12063b8",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 61964,
"upload_time": "2025-07-26T22:30:06",
"upload_time_iso_8601": "2025-07-26T22:30:06.878759Z",
"url": "https://files.pythonhosted.org/packages/e3/cc/44a0ccaafdb65714bd159b67ccdeae7caab782fe6a65bb2193c220d6ce5e/astdoc-1.3.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-26 22:30:06",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "daizutabi",
"github_project": "astdoc",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "astdoc"
}
