lazynote 0.1.0

AI-powered automatic generation of documentation comments for classes, modules, and packages, including translation of existing comments and lazy customization of docstrings.

Lazynote 🚀✨

Lazynote is an AI-powered tool that can automatically generate documentation comments for classes, modules, and packages. It also supports translation and customization of existing comments. 💡📝

Features 🌟

• Automatic Generation: Automatically generate documentation comments for classes, modules, and packages. 🛠️
• Smart Translation: Translate existing comments, supporting multiple languages. 🌐
• Comment Polishing: Use AI technology to polish comments for improved readability. 📖✨
• Flexible Customization: Easily customize all comments across the entire repository. 🔧

Installation 📦

You can easily install Lazynote using pip:

pip install lazynote

Quick Start 🚀

Here is a simple example demonstrating how to use Lazynote to automatically generate and manage documentation comments.

import pytest
from lazynote.manager import SimpleManager
manager = SimpleManager(pattern='fill')
manager.traverse(lazyllm_package.components, 
                skip_modules=['lazyllm.components.deploy.relay.server'])

Features Overview 📚

Lazynote provides the following modes to easily customize all comments across the entire repository using AI and source code:

• TRANSLATE: Translate existing comments. 🌍
• POLISH: Polish and optimize comments. 💅
• CLEAR: Clear existing comments. 🗑️
• FILL: Fill in missing comments. 📝

Contributing 🌟

Contributions are welcome! Please read CONTRIBUTING.md for more information. 💖

License 📄

This project is licensed under the MIT License. For more details, please refer to LICENSE. 📝

---