معرفی شرکت ها

aidoc-0.1.5

Card image cap
تبلیغات ما

مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.

مشاهده بیشتر
Card image cap
تبلیغات ما

مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.

مشاهده بیشتر
Card image cap
تبلیغات ما

مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.

مشاهده بیشتر
Card image cap
تبلیغات ما

مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.

مشاهده بیشتر
Card image cap
تبلیغات ما

مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.

مشاهده بیشتر
0.1.5
0.1.4
0.1.3
0.1.2
0.1.1
0.1.0
0.1.5
0.1.4
0.1.3
0.1.2
0.1.1
0.1.0

توضیحات

A simple CLI tool to generate documentation for your Python projects automatically.
ویژگی مقدار
سیستم عامل -
نام فایل aidoc-0.1.5
نام aidoc
نسخه کتابخانه 0.1.5
نگهدارنده []
ایمیل نگهدارنده []
نویسنده Saikat Kumar Dey
ایمیل نویسنده deysaikatkumar@gmail.com
آدرس صفحه اصلی https://github.com/saikatkumardey/aidoc
آدرس اینترنتی https://pypi.org/project/aidoc/
مجوز -
[![PyPI](https://badge.fury.io/py/aidoc.svg)](https://pypi.org/project/aidoc/) # aidoc aidoc is a command line interface (CLI) tool that uses AI to automatically generate documentation for your code. ## Requirements - OpenAI API key: [https://beta.openai.com/](https://beta.openai.com/) - Python 3.6 or higher ## Installation - globally install the package ``` python3 -m pip install aidoc ``` - (recommended) create a virtual environment and install the package ```bash pip install aidoc ``` ## Usage To configure the API key and model for aidoc, run the following command: ``` aidoc configure ``` To generate documentation for a source file or directory, run the following command: ``` aidoc gen <source_file> ``` You can also specify the following optional arguments: - `-o` or `--overwrite`: Overwrite existing docstrings - `-f` or `--format`: Format the entire source file using black (default=True) - `-pr` or `--pull-request`: Create a pull request with the changes ## Examples **Generate docstrings for the main.py file:** ``` aidoc gen main.py ``` **Generate docstrings for all Python files in the src directory and its subdirectories:** ``` aidoc gen src ``` **Generate docstrings and create a pull request with the changes:** ``` aidoc gen main.py -pr ``` ## Contributing Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change. ## License This project is licensed under the GNU General Public License v3.0 - see the [LICENSE](LICENSE) file for details. ## Acknowledgments * [OpenAI](https://openai.com/) ## Disclaimer This project is not affiliated with OpenAI. The OpenAI API and GPT-3 language model are not free. You will need to sign up for a free [OpenAI](https://beta.openai.com/) account and create an API key to use this tool.


نیازمندی

مقدار نام
==0.8.1 astor
==22.12.0 black
==0.25.0 openai
==0.21.0 python-dotenv
==65.6.3 setuptools


زبان مورد نیاز

مقدار نام
>=3.6 Python


نحوه نصب


نصب پکیج whl aidoc-0.1.5:

    pip install aidoc-0.1.5.whl


نصب پکیج tar.gz aidoc-0.1.5:

    pip install aidoc-0.1.5.tar.gz