# documentation-generator
## Overeview
This is a python library for generating documentation for python projects. It is built to:
- Generate function docstrings
- Generate class docstrings include class method docstrings (still under development)
- Generate sphinx documentation (still under development)
The library uses ``openai's`` gpt model to generate the function docstrings. You pass it a file or folder path togther with an ``openai`` api key. It then parses the folder for python files, then for each file, it finds the functions and classes, generates their documentation and updates their docstrings.
## Requirements
- Python 3.10+
- Works on Linux, Windows, macOS, BSD
## Installation
```sh
pip install oryks-docstring-generator
```
## Usage
First, provide the ``openai`` api key:
```sh
export OPENAI_API_KEY=sk-xxxxxxxxxxx
```
Then run the application, providing the path to the python file to generate docs for or the folder containing the python files:
```sh
python -m docstring_generator --path /home/lyle/tutorial/test-docstrings-generator/test/ --directories-ignore venv
--files-ignore test.py --overwrite-function-docstring True --overwrite-class-docstring True --overwrite-class-methods-docstring True --documentation-style Numpy-Style
```
<p align=center>
<img src="docstring-generator.gif" />
</p>
## Documentation and Tutorials
To learn more about the library including the documentation and tutorials, check out the [libraries' documentation](https://youtube-wrapper.readthedocs.io/en/latest/).
## How to Contribute
To contribute, chack out the [contribution guideline](CONTRIBUTING.md).
## License
The API uses an [MIT License](LICENSE)
## Developer
Lyle Okoth – [@lyleokoth](https://twitter.com/lyleokoth) on twitter
[lyle okoth](https://medium.com/@lyle-okoth) on medium
My email is lyceokoth@gmail.com
Here is my [GitHub Profile](https://github.com/twyle/)
You can also find me on [Linkedin](https://www.linkedin.com/in/lyle-okoth/)
Raw data
{
"_id": null,
"home_page": "https://youtube-wrapper.readthedocs.io/en/latest/index.html",
"name": "oryks-docstring-generator",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "dosctrings,documentation",
"author": "Lyle Okoth",
"author_email": "lyceokoth@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/ba/bd/e20b84148bb676eecce71255658c8dfa82d2051c1f3b5c8071039f541eef/oryks-docstring-generator-0.5.0.tar.gz",
"platform": null,
"description": "# documentation-generator\n\n## Overeview\n\nThis is a python library for generating documentation for python projects. It is built to:\n\n- Generate function docstrings\n- Generate class docstrings include class method docstrings (still under development)\n- Generate sphinx documentation (still under development)\n\nThe library uses ``openai's`` gpt model to generate the function docstrings. You pass it a file or folder path togther with an ``openai`` api key. It then parses the folder for python files, then for each file, it finds the functions and classes, generates their documentation and updates their docstrings.\n\n## Requirements\n\n- Python 3.10+\n- Works on Linux, Windows, macOS, BSD\n\n## Installation\n\n```sh\npip install oryks-docstring-generator\n```\n\n## Usage\n\nFirst, provide the ``openai`` api key:\n\n```sh\nexport OPENAI_API_KEY=sk-xxxxxxxxxxx\n```\n\nThen run the application, providing the path to the python file to generate docs for or the folder containing the python files:\n\n```sh\npython -m docstring_generator --path /home/lyle/tutorial/test-docstrings-generator/test/ --directories-ignore venv\n--files-ignore test.py --overwrite-function-docstring True --overwrite-class-docstring True --overwrite-class-methods-docstring True --documentation-style Numpy-Style\n```\n\n<p align=center>\n <img src=\"docstring-generator.gif\" />\n</p>\n\n## Documentation and Tutorials\n\nTo learn more about the library including the documentation and tutorials, check out the [libraries' documentation](https://youtube-wrapper.readthedocs.io/en/latest/).\n\n## How to Contribute\n\nTo contribute, chack out the [contribution guideline](CONTRIBUTING.md).\n\n## License\n\nThe API uses an [MIT License](LICENSE)\n\n## Developer\n\nLyle Okoth \u2013 [@lyleokoth](https://twitter.com/lyleokoth) on twitter\n\n[lyle okoth](https://medium.com/@lyle-okoth) on medium\n\nMy email is lyceokoth@gmail.com\n\nHere is my [GitHub Profile](https://github.com/twyle/)\n\nYou can also find me on [Linkedin](https://www.linkedin.com/in/lyle-okoth/)\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A python library for generating documentation for python projects.",
"version": "0.5.0",
"project_urls": {
"Homepage": "https://youtube-wrapper.readthedocs.io/en/latest/index.html"
},
"split_keywords": [
"dosctrings",
"documentation"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9d8d8da6100f2290d2ca8c1a44176c0d2a5acf6b7d26f3f16482948aeff10904",
"md5": "13973b9deec514421b28782fb2c3801e",
"sha256": "34b14794e77bafff6733c1986d58d7a1243b4387ce2f52f70758e475953cd7a7"
},
"downloads": -1,
"filename": "oryks_docstring_generator-0.5.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "13973b9deec514421b28782fb2c3801e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 10064,
"upload_time": "2024-01-15T13:42:18",
"upload_time_iso_8601": "2024-01-15T13:42:18.527636Z",
"url": "https://files.pythonhosted.org/packages/9d/8d/8da6100f2290d2ca8c1a44176c0d2a5acf6b7d26f3f16482948aeff10904/oryks_docstring_generator-0.5.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "babde20b84148bb676eecce71255658c8dfa82d2051c1f3b5c8071039f541eef",
"md5": "2de60232bfbab3a008acbfa2f03e86ce",
"sha256": "c8ad11ee0a3f88fb57984c412461f5697565dd35f7f2cdae34ea558ceb036da9"
},
"downloads": -1,
"filename": "oryks-docstring-generator-0.5.0.tar.gz",
"has_sig": false,
"md5_digest": "2de60232bfbab3a008acbfa2f03e86ce",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 9108,
"upload_time": "2024-01-15T13:42:20",
"upload_time_iso_8601": "2024-01-15T13:42:20.418639Z",
"url": "https://files.pythonhosted.org/packages/ba/bd/e20b84148bb676eecce71255658c8dfa82d2051c1f3b5c8071039f541eef/oryks-docstring-generator-0.5.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-15 13:42:20",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "oryks-docstring-generator"
}
JSON