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
- e.g. Javadoc, JSDoc, Docstring, Rustdoc
- ✍️ 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).aicomments <RELATIVE_FILE_PATH> --guided
: Guided mode, confirm documentation generation for each method.
⚙️ 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.6.tar.gz
(8.5 kB
view hashes)
Built Distribution
Close
Hashes for doc_comments_ai-0.1.6-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1308ed276b62234f2ee0e61a11b9028524017254a252746cf84169d36d1daecf |
|
MD5 | 4c6bf3ec7e465f7b31392ee59060f4ad |
|
BLAKE2b-256 | cd5c587abcf95a719085e6af7e18b89e665ed206d049586ccf7385b427566c58 |