codedoc-ai 0.1.4__tar.gz

codedoc_ai-0.1.4/.env.example

@@ -0,0 +1,23 @@
+# Copy this file to .env in the project you want to document.
+# Do not commit .env to Git.
+
+# OpenAI or OpenAI-compatible providers
+# OPENAI_API_KEY=sk-your-openai-key
+
+# Anthropic Claude
+# ANTHROPIC_API_KEY=sk-ant-your-anthropic-key
+
+# Generic fallback API key used by codedoc when provider-specific keys are absent
+# LLM_API_KEY=your-api-key
+
+# Local LLM mode: Ollama, LM Studio, llama.cpp server, or another OpenAI-compatible server
+# LLM_MODE=local
+# API_BASE_URL=http://localhost:11434/v1
+
+# Optional model and output settings
+# MODEL_NAME=gpt-4o-mini
+# OUTPUT_DIR=docs_output
+# LOG_LEVEL=INFO
+
+# Strict project-relative ignore paths, separated by semicolons
+# CODEDOC_IGNORE_PATHS=/myenv;services/generated

codedoc_ai-0.1.4/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,43 @@
+---
+name: Bug report
+about: Report a reproducible problem in codedoc-ai
+title: "[Bug]: "
+labels: bug
+assignees: ""
+---
+
+## What happened?
+
+Describe the bug clearly.
+
+## How to reproduce
+
+```bash
+# command you ran
+```
+
+## Expected behavior
+
+What did you expect to happen?
+
+## Environment
+
+- OS:
+- Python version:
+- codedoc-ai version:
+- LLM mode: `api` or `local`
+- Model:
+
+## Config
+
+Paste relevant config without secrets.
+
+```json
+{}
+```
+
+## Logs or error output
+
+```text
+paste logs here
+```

codedoc_ai-0.1.4/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,23 @@
+---
+name: Feature request
+about: Suggest an improvement for codedoc-ai
+title: "[Feature]: "
+labels: enhancement
+assignees: ""
+---
+
+## Problem
+
+What problem would this solve?
+
+## Proposed solution
+
+What would you like `codedoc-ai` to do?
+
+## Alternatives considered
+
+Any other approach you considered?
+
+## Additional context
+
+Add examples, links, or screenshots if useful.

codedoc_ai-0.1.4/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,21 @@
+## Summary
+
+Describe what this pull request changes.
+
+## Type of change
+
+- [ ] Bug fix
+- [ ] New feature
+- [ ] Documentation
+- [ ] Refactor
+- [ ] Tests
+
+## Verification
+
+- [ ] `python -m pytest`
+- [ ] `python -m build`
+- [ ] `python -m twine check dist/*`
+
+## Notes
+
+Anything reviewers should pay special attention to?

codedoc_ai-0.1.4/CHANGELOG.md

@@ -0,0 +1,66 @@
+# Changelog
+
+## 0.1.4 - 2026-05-02
+
+- Redesigned **public output structure** for cleaner, AI-friendly documentation.
+- Separated **internal cache (`codedoc_db.json`)** from **public output (`codedoc.json` / `codedoc.md`)**.
+- Added **project-level overview** including entry file, file count, languages, and folder summary.
+- Added **project tree visualization** in both JSON and Markdown outputs.
+- Added **folder-based grouping** with summarized purpose and file listings.
+- Introduced **dependency graph** with internal file relationships and external dependencies.
+- Flattened file structure in public output:
+  - Removed nested and duplicated `result` / `documentation` blocks.
+  - Consolidated descriptions, roles, functions, classes, and exports into a single clean structure.
+- Added **file-level linking metadata**:
+  - `internal_dependencies`
+  - `external_dependencies`
+  - `imported_by`
+- Removed **author and git metadata** from public output by default.
+- Improved **Markdown output (`--format md`)**:
+  - Added Project Overview, Tree, Folder Map, Dependency Map, and structured file summaries.
+- Ensured **format-specific output behavior**:
+  - `--format md` → only `codedoc.md`
+  - `--format json` → only `codedoc.json`
+  - `--format both` → both files
+- Added **clear CLI and pipeline logging**:
+  - Displays selected output format
+  - Displays exact output file path
+- Added **BOM-safe file reading (`utf-8-sig`)** across Python, JS/TS, and generic parsers.
+- Ensured **language-agnostic processing** (no Python-only assumptions).
+- Added tests for:
+  - New public output structure
+  - Markdown generation
+  - Dependency graph presence
+  - Cross-language compatibility (including TS/TSX)
+- Cleaned up public output by removing:
+  - Cache history
+  - Raw agent responses
+  - Redundant description fields
+  
+## 0.1.3 - 2026-05-02
+
+- Changed generated docs to one combined JSON file by default.
+- Added `--format json|md|both` output selection.
+- Added smart content-hash reuse for unchanged and duplicate files.
+- Added cache-based output regeneration when selected docs are missing.
+- Redesigned public output with project overview, tree, folder map, dependency graph, and flattened file summaries.
+- Removed local author metadata and raw agent result duplication from public output.
+- Expanded public README with provider setup, defaults, config, output, and cache behavior.
+
+## 0.1.1 - 2026-05-01
+
+- Added safer default scanning for virtual environments such as `myenv`.
+- Added configurable `skip_dirs`.
+- Added strict project-relative ignore paths through CLI, config, environment, and Python API.
+- Added `--ignore PATH` CLI option.
+- Added scanner tests for virtual environment and strict path ignores.
+- Fixed misleading API key warning when CLI overrides select local LLM mode.
+
+## 0.1.0 - 2026-05-01
+
+- Initial alpha release.
+- Added entry-file dependency traversal.
+- Added local and API LLM provider support.
+- Added per-file Markdown and JSON output.
+- Added `_index.json`, `_summary.md`, and incremental `codedoc_db.json` memory.
+- Added CLI and Python API entry points.

codedoc_ai-0.1.4/CODE_OF_CONDUCT.md

@@ -0,0 +1,18 @@
+# Code of Conduct
+
+This project is intended to be a welcoming, practical space for people building developer tools.
+
+## Expected Behavior
+
+- Be respectful and constructive.
+- Assume good intent, but accept correction.
+- Keep criticism focused on code, design, documentation, and project direction.
+- Help make issues and pull requests clear for future readers.
+
+## Unacceptable Behavior
+
+- Harassment, insults, threats, or personal attacks.
+- Publishing private information or secrets.
+- Disruptive behavior that makes collaboration harder.
+
+Maintainers may close issues, remove comments, or block users who repeatedly violate these expectations.

codedoc_ai-0.1.4/CONTRIBUTING.md

@@ -0,0 +1,65 @@
+# Contributing
+
+Thanks for helping improve `codedoc-ai`.
+
+## How Contributions Work
+
+1. Fork the repository.
+2. Create a branch from `main`.
+3. Make your changes.
+4. Add or update tests when behavior changes.
+5. Run the verification commands.
+6. Open a pull request with a clear description.
+
+## Development Setup
+
+```bash
+git clone https://github.com/atharvm416/codedoc-ai.git
+cd codedoc-ai
+python -m venv .venv
+.venv\Scripts\activate
+pip install -e ".[dev]"
+```
+
+On macOS/Linux:
+
+```bash
+source .venv/bin/activate
+```
+
+## Verification
+
+Run these before opening a pull request:
+
+```bash
+python -m pytest
+python -m build
+python -m twine check dist/*
+```
+
+## Good First Contributions
+
+- Add parser fixtures for more frameworks.
+- Improve import resolution for a specific language.
+- Add tests for edge cases in dependency traversal.
+- Improve documentation examples.
+- Add provider support for another OpenAI-compatible local server.
+
+## Pull Request Guidelines
+
+- Keep changes focused.
+- Explain why the change is needed.
+- Include before/after behavior when fixing a bug.
+- Do not commit `.env`, API keys, `docs_output`, `codedoc_db.json`, `dist`, or virtual environments.
+- Keep generated artifacts out of pull requests unless a maintainer asks for them.
+
+## Reporting Bugs
+
+Please include:
+
+- Your operating system.
+- Python version.
+- `codedoc-ai` version.
+- The command you ran.
+- Relevant config without secrets.
+- A small reproduction project or fixture when possible.

codedoc_ai-0.1.4/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Atharv Mannur
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

codedoc_ai-0.1.4/MANIFEST.in

@@ -0,0 +1,10 @@
+include README.md
+include LICENSE
+include CHANGELOG.md
+include CONTRIBUTING.md
+include SECURITY.md
+include CODE_OF_CONDUCT.md
+include .env.example
+recursive-include tests *.py
+recursive-include tests/fixtures *
+recursive-include .github *.md