AI-powered documentation generator for code projects
Project description
Docagent
A python project written in python.
Overview
This project contains 9 files with 1,337 lines of code across 2 programming languages.
Project Structure
├── requirements.txt
├── pyproject.toml
├── setup.py
├── tests/
│ └── __init__.py
└── docagent/
├── __init__.py
├── providers.py
├── cli.py
├── analyzer.py
└── core.py
Languages Used
- Python: 7 files, 1,258 lines (94.1%)
- Text: 2 files, 79 lines (5.9%)
Main Files
- setup.py (python) - 2,192 bytes
- pyproject.toml (text) - 2,184 bytes
- requirements.txt (text) - 38 bytes
Installation
Python Setup
# Clone the repository
git clone <repository-url>
cd DocAgent
# Create virtual environment
python -m venv venv
source venv/bin/activate # On Windows: venv\Scripts\activate
# Install dependencies
pip install -r requirements.txt
Usage
Refer to the main files and source code for specific usage instructions. Key entry points are typically found in:
setup.py- Python filepyproject.toml- Text filerequirements.txt- Text file
File Overview
tests/init.py
- Language: Python
- Lines: 1
- Size: 36 bytes
Preview: """tests for the DocAgent package"""
docagent/init.py
- Language: Python
- Lines: 7
- Size: 239 bytes
Preview: version = "1.0.0" author = "Ansh Tyagi" email = "anshtyagi314159@gmail.com" from .core import DocAgent from .analyzer import CodeAnalyzer from .providers import LLMManager all = ["D...
docagent/analyzer.py
- Language: Python
- Lines: 472
- Size: 21,031 bytes
Preview: import os import hashlib from pathlib import Path from typing import Dict, List, Any, Optional from datetime import datetime from dataclasses import dataclass @dataclass class CodeFile: """Represe...
docagent/core.py
- Language: Python
- Lines: 393
- Size: 16,757 bytes
Preview: import os import sys import argparse from pathlib import Path from typing import Dict, List, Any from datetime import datetime from .analyzer import CodeAnalyzer from .providers import LLMManager, Fa...
docagent/providers.py
- Language: Python
- Lines: 319
- Size: 14,472 bytes
Preview: import os import time import requests from abc import ABC, abstractmethod from enum import Enum from typing import Optional from dotenv import load_dotenv from dataclasses import dataclass load_dotenv...
... and 4 more files
Development
To contribute to this project:
- Fork the repository
- Create a feature branch
- Make your changes
- Test thoroughly
- Submit a pull request
Architecture
The project is organized as follows:
- Python: 7 files containing core functionality
- Text: 2 files containing core functionality
Dependencies
Based on the project structure, you may need:
- Python 3.7+ and pip
- Virtual environment (recommended)
Statistics
- Total Files: 9
- Total Lines: 1,337
- Languages: 2
- Last Analyzed: 2025-05-29 17:00:10
This documentation was generated automatically by DocAgent v2. For more detailed information, please refer to the source code and comments within individual files.
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
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file llm_docagent-1.0.0.tar.gz.
File metadata
- Download URL: llm_docagent-1.0.0.tar.gz
- Upload date:
- Size: 18.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.12.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
84c164ba0bb2049e92c137a23b1dbf73b7b4d65a3539a8a692e99ed24a8d3d9f
|
|
| MD5 |
e7dff147cf31e085fb08d06b377d9272
|
|
| BLAKE2b-256 |
097304f2fc8ad4d457e693b63202ab428e14c028f50fea43561a561f83391ae9
|
File details
Details for the file llm_docagent-1.0.0-py3-none-any.whl.
File metadata
- Download URL: llm_docagent-1.0.0-py3-none-any.whl
- Upload date:
- Size: 17.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.12.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
1fcd6f91aff875ca2ed059be773dc2952c2d8d21a19aaeae2a6e898b3796faf7
|
|
| MD5 |
32f6aa2e91b41e8b8123ce74d7408652
|
|
| BLAKE2b-256 |
289f3cd090d581a184e7f5541696fa95dd50b2c593ac5af5f970b228f2d5096e
|