Security News
Introducing the Socket Python SDK
The initial version of the Socket Python SDK is now on PyPI, enabling developers to more easily interact with the Socket REST API in Python projects.
aidoc is a command line interface (CLI) tool that uses AI to automatically generate documentation for your code.
python3 -m pip install aidoc
pip install aidoc
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 changesGenerate 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
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
This project is licensed under the GNU General Public License v3.0 - see the LICENSE file for details.
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 account and create an API key to use this tool.
FAQs
A simple CLI tool to generate documentation for your Python projects automatically.
We found that aidoc demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
The initial version of the Socket Python SDK is now on PyPI, enabling developers to more easily interact with the Socket REST API in Python projects.
Security News
Floating dependency ranges in npm can introduce instability and security risks into your project by allowing unverified or incompatible versions to be installed automatically, leading to unpredictable behavior and potential conflicts.
Security News
A new Rust RFC proposes "Trusted Publishing" for Crates.io, introducing short-lived access tokens via OIDC to improve security and reduce risks associated with long-lived API tokens.