devDocs 0.1.0

A CLI tool to auto-generate professional README.md files using Google Gemini API.

My Project

Folder Structure

.
├── main.py
├── secret
└── setup.py

Description

No description provided.

How to Use

No usage instructions provided. Refer to main.py and setup.py for potential execution details.

Technologies Used

• Python

Architecture or Code Overview

No architecture or code overview provided. Requires inspection of source files main.py, secret, and setup.py.

Known Issues / Improvements

• No issues or improvements are provided.

Additional Notes or References

• Authors: Anonymous
• Keywords: # README

cli.py

Folder Structure

.
├── cli.py
└── docs

Description

This Python script automatically generates README.md documentation for a project by parsing the source code and folder structure. It utilizes the Google Gemini API to generate the documentation content and organizes the output within a specified directory.

How to Use

1. Install Dependencies:

   • Ensure you have Python and pip installed.
   • Install the required packages: pip install google-genai

2. Get a Google Gemini API Key:

   • Obtain an API key from Google AI Studio.

3. Run the Script:

   • Navigate to the project directory in your terminal.
   • Execute the script using: python cli.py [OPTIONS]
   • When prompted, paste your Google Gemini API Key.

   CLI Options:

   • -p or --path: Root path to scan (default: ., current directory)
   • --name: Project name to include in README (default: My Project)
   • --description: Short description of the project (default: No description provided.)
   • --authors: Comma-separated list of author names (default: Anonymous)
   • --keywords: Comma-separated keywords (e.g., cli, docs, auto) (default: None)
   • --overwrite: Overwrite existing README files (default: False)
   • --output: Output directory where docs will be stored (default: docs)
   • --exclude: Folders, files, extensions to exclude (e.g., docs, ext, setting, config)
   • --include: Folders, files, extensions to include (e.g., docs, ext, setting, config)

   Example:

   python cli.py --path . --name "My Awesome Project" --description "A brief description of the project" --authors "Gantavya Bansal" --keywords "cli, documentation" --overwrite --output docs
   

Technologies Used

• Python: Programming language.
• google-genai: Google Generative AI library.
• argparse: Parsing command-line arguments.
• os: File system operations.
• logging: Logging errors and information.

Architecture or Code Overview

The script operates as follows:

1. Initialization: Sets up logging and imports necessary modules.
2. Argument Parsing: Uses argparse to handle command-line arguments.
3. File System Traversal:
   • d(): Recursively traverses the directory structure, excluding and including files based on user-defined filters.
   • b(): Generates a tree view of the project's folder structure.
4. File Reading:
   • u(): Reads the content of a code file.
   • K(): Reads an existing README file.
5. Documentation Generation:
   • s(): Interacts with the Google Gemini API, passing the filename, code, and existing README to generate the Markdown documentation.
6. README Writing:
   • c(): Writes the generated documentation to a README.md file.
7. Main Execution: The x() function handles the main workflow: parses arguments, sets up the Gemini API client, traverses the file structure, and generates the documentation.

Known Issues / Improvements

• Error handling for API failures is basic. Implement more robust retry mechanisms.
• Improve the exclusion and inclusion logic to support more complex patterns.
• Enhance the prompt sent to the Gemini API for more accurate and detailed documentation.
• Add support for different output formats (e.g., other than Markdown).

Additional Notes or References

• This script utilizes the Google Gemini API. Ensure you have a valid API key.
• The generated documentation is based on the provided context and the Gemini API's output.
• Consider licensing your project with a license file.