No project description provided
Project description
Focus on writing your code, let AI write the documentation for you. With just a few keystrokes in your terminal.
✨ Features
- Create documentation comment blocks for all methods in a file
- Create inline documentation comments in method bodies
- Treesitter integration
[!NOTE] Documentations will only be added to files without unstaged changes, so that nothing is overwritten.
🚀 Usage
aicomments <RELATIVE_FILE_PATH>
: Create documentations for any method in the file which doesn't have any yet.aicomments <RELATIVE_FILE_PATH> --inline
: Create also documentation comments in the method body.aicomments <RELATIVE_FILE_PATH> --gpt4
: Use GPT-4 model (Default is GPT-3.5).
⚙️ Supported Languages
- Python
- Typescript
- Javascript
- Java
- Rust
- Kotlin
- Go
- C++
- C
- Scala
📋 Requirements
- Python >= 3.9
🔧 Installation
Create your personal OpenAI Api key and add it as $OPENAI_API_KEY
to your environment with:
export OPENAI_API_KEY=<YOUR_API_KEY>
Install with pipx
:
pipx install doc-comments-ai
[!NOTE] It is recommended to use
pipx
for installation, nonetheless it is also possible to usepip
.
🚨 Disclaimer
Your code won't be stored, but your code does leave your machine.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
doc_comments_ai-0.1.3.tar.gz
(7.8 kB
view hashes)
Built Distribution
Close
Hashes for doc_comments_ai-0.1.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f5e8d8f9d422fd6dc0d56c960ad0ccbb60ddf96bb678b9a8bcf5608fd0b0b2ea |
|
MD5 | 3dc0af8ee8ae5645834d07982dc7b68c |
|
BLAKE2b-256 | 1d791fa77b3ce9ec48fc18c42c19508f25ab6c579ae162ccb69d4fe11a995ee6 |