# PDTJ - (Python Docstring To Json)
## Introduction
This project was created to solve a personal need for a flexible and simple tool to retrieve all
Python docstrings and convert them into a JSON format. The tool's design provides flexibility to
customize the parsing and documentation process, making it easy to navigate through the codebase's structure and
documentation.
This project aims to provide a powerful tool for parsing and documenting Python code within a directory. The tool works
by recursively traversing a directory and identifying all Python files contained within it. It then extracts the
docstrings of these files, organizing them into a dictionary format that captures the structure and documentation of the
entire codebase. This dictionary is then written to a JSON file, making it easy to view and access the information
it contains.
Whether you're a software developer or a codebase maintainer,
this tool can help you gain a deeper understanding of your Python code and streamline the documentation
process.
Moreover, this tool aims to simplify the process of generating a documentation webpage by
using the JSON file. It provides a clear overview of the codebase's structure and documentation,
allowing users to quickly navigate through the code and understand its functionality.
The project is designed to be flexible and customizable, enabling users to tailor the parsing
and documentation process to their specific needs. With this tool, you can easily generate comprehensive
documentation for your Python codebase and share it with others.
# How to Use
## Installation
To install the tool, run the following command:
```shell
pip install pdtj
```
Next, create a ```.pdtj.yaml``` file in the root directory of your project and specify the following information:
```shell
name: <project name> # replace <project name> with your project's name
shelve: <shelve name> # choose any name you like for <shelve name>
sub-project: <sub-project name> # choose any name you like for <sub-project name>
```
## Generating the Documentation
Once you have installed the tool and configured the ```.pdtj.yaml``` file, you can generate the documentation by running
the following command:
```shell
pdtj
```
If everything is set up correctly, the tool will traverse your project directory, extract the docstrings from all Python
files, and create a JSON file containing the documentation. The resulting file can be used to generate a
documentation webpage or for any other purpose.
# Features missing
- [ ] Log
- [ ] Unit tests
# License
This project is licensed under the MIT License - see the [LICENSE](https://github.com/Joaopeuko/pdtj/blob/master/LICENSE) file for details.
Raw data
{
"_id": null,
"home_page": "https://github.com/Joaopeuko/pdtj",
"name": "pdtj",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "python,docstring,json",
"author": "Joao Paulo Euko",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/8c/db/fb4d335c72074ee78e112b981dfc4b71d9e20f456140e877dbda0fcb27c5/pdtj-0.3.4.tar.gz",
"platform": null,
"description": "\n\n\n\n\n# PDTJ - (Python Docstring To Json)\n\n## Introduction\n\nThis project was created to solve a personal need for a flexible and simple tool to retrieve all\nPython docstrings and convert them into a JSON format. The tool's design provides flexibility to\ncustomize the parsing and documentation process, making it easy to navigate through the codebase's structure and\ndocumentation.\n\nThis project aims to provide a powerful tool for parsing and documenting Python code within a directory. The tool works\nby recursively traversing a directory and identifying all Python files contained within it. It then extracts the\ndocstrings of these files, organizing them into a dictionary format that captures the structure and documentation of the\nentire codebase. This dictionary is then written to a JSON file, making it easy to view and access the information\nit contains.\nWhether you're a software developer or a codebase maintainer,\nthis tool can help you gain a deeper understanding of your Python code and streamline the documentation\nprocess.\n\nMoreover, this tool aims to simplify the process of generating a documentation webpage by\nusing the JSON file. It provides a clear overview of the codebase's structure and documentation,\nallowing users to quickly navigate through the code and understand its functionality.\nThe project is designed to be flexible and customizable, enabling users to tailor the parsing\nand documentation process to their specific needs. With this tool, you can easily generate comprehensive\ndocumentation for your Python codebase and share it with others.\n\n# How to Use\n\n## Installation\n\nTo install the tool, run the following command:\n```shell\npip install pdtj\n```\n\nNext, create a ```.pdtj.yaml``` file in the root directory of your project and specify the following information:\n```shell\nname: <project name> # replace <project name> with your project's name\nshelve: <shelve name> # choose any name you like for <shelve name>\nsub-project: <sub-project name> # choose any name you like for <sub-project name>\n```\n\n\n## Generating the Documentation\nOnce you have installed the tool and configured the ```.pdtj.yaml``` file, you can generate the documentation by running\nthe following command:\n\n```shell\npdtj\n```\n\nIf everything is set up correctly, the tool will traverse your project directory, extract the docstrings from all Python\nfiles, and create a JSON file containing the documentation. The resulting file can be used to generate a\ndocumentation webpage or for any other purpose.\n\n\n\n# Features missing\n\n- [ ] Log\n- [ ] Unit tests\n\n# License\nThis project is licensed under the MIT License - see the [LICENSE](https://github.com/Joaopeuko/pdtj/blob/master/LICENSE) file for details.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "",
"version": "0.3.4",
"split_keywords": [
"python",
"docstring",
"json"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "86bf517340ffece604efc94b72691cbb40ae204e817cbd959bcded78498aea20",
"md5": "4a2c0c4758b9e616f9e289956e4dbb8f",
"sha256": "4078b20c741acb89027a3f12c887cfc7a4a4332e6084543ebdbbd3037a362c23"
},
"downloads": -1,
"filename": "pdtj-0.3.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4a2c0c4758b9e616f9e289956e4dbb8f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 9087,
"upload_time": "2023-03-21T10:57:17",
"upload_time_iso_8601": "2023-03-21T10:57:17.108753Z",
"url": "https://files.pythonhosted.org/packages/86/bf/517340ffece604efc94b72691cbb40ae204e817cbd959bcded78498aea20/pdtj-0.3.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8cdbfb4d335c72074ee78e112b981dfc4b71d9e20f456140e877dbda0fcb27c5",
"md5": "6f3bea54966bcb053a32081ff8df6526",
"sha256": "2c7701f1040358ea54f3af4b974ac5e72dcc0d4301666dfb94dfeea92d77b07d"
},
"downloads": -1,
"filename": "pdtj-0.3.4.tar.gz",
"has_sig": false,
"md5_digest": "6f3bea54966bcb053a32081ff8df6526",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 8793,
"upload_time": "2023-03-21T10:57:18",
"upload_time_iso_8601": "2023-03-21T10:57:18.644946Z",
"url": "https://files.pythonhosted.org/packages/8c/db/fb4d335c72074ee78e112b981dfc4b71d9e20f456140e877dbda0fcb27c5/pdtj-0.3.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-03-21 10:57:18",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "Joaopeuko",
"github_project": "pdtj",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "pdtj"
}
JSON
