# CodeViewX
> AI-Powered Code Documentation Generator
[δΈζ](README.zh.md) | English
[](https://pypi.org/project/codeviewx/)
[](https://pypi.org/project/codeviewx/)
[](https://www.gnu.org/licenses/gpl-3.0)
[](https://pypi.org/project/codeviewx/)
CodeViewX automatically analyzes your codebase and generates professional technical documentation using AI (Anthropic Claude + DeepAgents + LangChain).
## β¨ Key Features
- π€ **AI-Powered Analysis**: Automatically understands code structure and business logic
- π **Complete Documentation**: Generates 8 standard chapters (overview, quick start, architecture, core mechanisms, data models, API reference, development guide, testing)
- π **Multi-Language**: Supports Chinese, English, Japanese, Korean, French, German, Spanish, Russian
- π₯οΈ **Documentation Browser**: Built-in web server for elegant documentation display
- β‘ **Fast Search**: Integrated ripgrep for high-speed code search
## π¦ Quick Start
### Installation
```bash
# Install CodeViewX
pip install codeviewx
# Install ripgrep (code search tool)
brew install ripgrep # macOS
# sudo apt install ripgrep # Ubuntu/Debian
# Configure API Key and base url
export ANTHROPIC_AUTH_TOKEN='your-api-key-here'
export ANTHROPIC_BASE_URL='https://api.anthropic.com/v1'
```
Get your API key at [Anthropic Console](https://console.anthropic.com/)
### Basic Usage
```bash
# Generate documentation for current directory
codeviewx
# Specify project path and language
codeviewx -w /path/to/project -l English -o docs
# Start documentation browser
codeviewx --serve -o docs
```
### Python API
```python
from codeviewx import generate_docs, start_document_web_server
# Generate documentation
generate_docs(
working_directory="/path/to/project",
output_directory="docs",
doc_language="English"
)
# Start web server
start_document_web_server("docs")
```
## π Documentation
For complete documentation, visit the [docs/en](docs/en/) directory:
- [π Overview](docs/en/01-overview.md) - Tech stack and project structure
- [π Quick Start](docs/en/02-quickstart.md) - Detailed installation and configuration
- [ποΈ Architecture](docs/en/03-architecture.md) - Architecture design and components
- [βοΈ Core Mechanisms](docs/en/04-core-mechanisms.md) - Deep dive into how it works
- [π API Reference](docs/en/06-api-reference.md) - Complete API documentation
- [π¨βπ» Development Guide](docs/en/07-development-guide.md) - Development and contribution guide
- [π§ͺ Testing](docs/en/08-testing.md) - Testing strategies and examples
- [π Security](docs/en/09-security.md) - Security best practices
- [β‘ Performance](docs/en/10-performance.md) - Performance optimization
- [π Deployment](docs/en/11-deployment.md) - Deployment guide
- [π§ Troubleshooting](docs/en/12-troubleshooting.md) - Common issues and solutions
## π§ Troubleshooting
Having issues? Check the [detailed documentation](docs/en/12-troubleshooting.md) for help.
**Quick Tips:**
- API key error? Ensure `ANTHROPIC_AUTH_TOKEN` environment variable is set correctly
- Search not working? Check if `ripgrep` is installed
- More questions? See [docs/en](docs/en/) for complete documentation
## π€ Contributing
Contributions are welcome! See [Contributing Guide](CONTRIBUTING.md) for details.
## π License
GNU General Public License v3.0 - see [LICENSE](LICENSE) file.
## π Acknowledgments
Built with [Anthropic Claude](https://www.anthropic.com/), [DeepAgents](https://github.com/langchain-ai/deepagents), [LangChain](https://www.langchain.com/), and [ripgrep](https://github.com/BurntSushi/ripgrep).
---
β Star this project if you find it helpful!
Raw data
{
"_id": null,
"home_page": null,
"name": "codeviewx",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "documentation, ai, code-analysis, deepagents, langchain, code-documentation, document-generation",
"author": "CodeViewX Team",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/0d/a1/9cb4217a74fa20d89a48956fd719524465582fc43551303c70e764cd5fa1/codeviewx-0.2.8.tar.gz",
"platform": null,
"description": "# CodeViewX\n\n> AI-Powered Code Documentation Generator\n\n[\u4e2d\u6587](README.zh.md) | English\n\n[](https://pypi.org/project/codeviewx/)\n[](https://pypi.org/project/codeviewx/)\n[](https://www.gnu.org/licenses/gpl-3.0)\n[](https://pypi.org/project/codeviewx/)\n\nCodeViewX automatically analyzes your codebase and generates professional technical documentation using AI (Anthropic Claude + DeepAgents + LangChain).\n\n## \u2728 Key Features\n\n- \ud83e\udd16 **AI-Powered Analysis**: Automatically understands code structure and business logic\n- \ud83d\udcdd **Complete Documentation**: Generates 8 standard chapters (overview, quick start, architecture, core mechanisms, data models, API reference, development guide, testing)\n- \ud83c\udf10 **Multi-Language**: Supports Chinese, English, Japanese, Korean, French, German, Spanish, Russian\n- \ud83d\udda5\ufe0f **Documentation Browser**: Built-in web server for elegant documentation display\n- \u26a1 **Fast Search**: Integrated ripgrep for high-speed code search\n\n## \ud83d\udce6 Quick Start\n\n### Installation\n\n```bash\n# Install CodeViewX\npip install codeviewx\n\n# Install ripgrep (code search tool)\nbrew install ripgrep # macOS\n# sudo apt install ripgrep # Ubuntu/Debian\n\n# Configure API Key and base url\nexport ANTHROPIC_AUTH_TOKEN='your-api-key-here'\nexport ANTHROPIC_BASE_URL='https://api.anthropic.com/v1'\n```\n\nGet your API key at [Anthropic Console](https://console.anthropic.com/)\n\n### Basic Usage\n\n```bash\n# Generate documentation for current directory\ncodeviewx\n\n# Specify project path and language\ncodeviewx -w /path/to/project -l English -o docs\n\n# Start documentation browser\ncodeviewx --serve -o docs\n```\n\n### Python API\n\n```python\nfrom codeviewx import generate_docs, start_document_web_server\n\n# Generate documentation\ngenerate_docs(\n working_directory=\"/path/to/project\",\n output_directory=\"docs\",\n doc_language=\"English\"\n)\n\n# Start web server\nstart_document_web_server(\"docs\")\n```\n\n## \ud83d\udcda Documentation\n\nFor complete documentation, visit the [docs/en](docs/en/) directory:\n\n- [\ud83d\udcd6 Overview](docs/en/01-overview.md) - Tech stack and project structure\n- [\ud83d\ude80 Quick Start](docs/en/02-quickstart.md) - Detailed installation and configuration\n- [\ud83c\udfd7\ufe0f Architecture](docs/en/03-architecture.md) - Architecture design and components\n- [\u2699\ufe0f Core Mechanisms](docs/en/04-core-mechanisms.md) - Deep dive into how it works\n- [\ud83d\udd0c API Reference](docs/en/06-api-reference.md) - Complete API documentation\n- [\ud83d\udc68\u200d\ud83d\udcbb Development Guide](docs/en/07-development-guide.md) - Development and contribution guide\n- [\ud83e\uddea Testing](docs/en/08-testing.md) - Testing strategies and examples\n- [\ud83d\udd12 Security](docs/en/09-security.md) - Security best practices\n- [\u26a1 Performance](docs/en/10-performance.md) - Performance optimization\n- [\ud83d\ude80 Deployment](docs/en/11-deployment.md) - Deployment guide\n- [\ud83d\udd27 Troubleshooting](docs/en/12-troubleshooting.md) - Common issues and solutions\n\n## \ud83d\udd27 Troubleshooting\n\nHaving issues? Check the [detailed documentation](docs/en/12-troubleshooting.md) for help.\n\n**Quick Tips:**\n- API key error? Ensure `ANTHROPIC_AUTH_TOKEN` environment variable is set correctly\n- Search not working? Check if `ripgrep` is installed\n- More questions? See [docs/en](docs/en/) for complete documentation\n\n## \ud83e\udd1d Contributing\n\nContributions are welcome! See [Contributing Guide](CONTRIBUTING.md) for details.\n\n## \ud83d\udcc4 License\n\nGNU General Public License v3.0 - see [LICENSE](LICENSE) file.\n\n## \ud83d\ude4f Acknowledgments\n\nBuilt with [Anthropic Claude](https://www.anthropic.com/), [DeepAgents](https://github.com/langchain-ai/deepagents), [LangChain](https://www.langchain.com/), and [ripgrep](https://github.com/BurntSushi/ripgrep).\n\n---\n\n\u2b50 Star this project if you find it helpful!\n",
"bugtrack_url": null,
"license": "GPL-3.0-or-later",
"summary": "AI-powered code documentation generator based on DeepAgents and LangChain",
"version": "0.2.8",
"project_urls": {
"Bug Tracker": "https://github.com/dean2021/codeviewx/issues",
"Documentation": "https://github.com/dean2021/codeviewx/tree/main/docs",
"Homepage": "https://github.com/dean2021/codeviewx",
"Repository": "https://github.com/dean2021/codeviewx"
},
"split_keywords": [
"documentation",
" ai",
" code-analysis",
" deepagents",
" langchain",
" code-documentation",
" document-generation"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "0cf0a8beda68d19453260392677cdd67a7b1eaddb914618953b4d4033f507367",
"md5": "07f053c70b723ed62c3017b031f061a2",
"sha256": "5076cb84b95c30865c25cb15cc958a32cb276d93f9a256c366259a61166f05a6"
},
"downloads": -1,
"filename": "codeviewx-0.2.8-py3-none-any.whl",
"has_sig": false,
"md5_digest": "07f053c70b723ed62c3017b031f061a2",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 43819,
"upload_time": "2025-10-22T08:27:58",
"upload_time_iso_8601": "2025-10-22T08:27:58.980617Z",
"url": "https://files.pythonhosted.org/packages/0c/f0/a8beda68d19453260392677cdd67a7b1eaddb914618953b4d4033f507367/codeviewx-0.2.8-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "0da19cb4217a74fa20d89a48956fd719524465582fc43551303c70e764cd5fa1",
"md5": "173475196c2c8e8e14861f2d9384bc2c",
"sha256": "3e87d055dc52cd3c38c5e40c77e48fa74dcf4736f8b36e3cc1fbcbd8ed481afc"
},
"downloads": -1,
"filename": "codeviewx-0.2.8.tar.gz",
"has_sig": false,
"md5_digest": "173475196c2c8e8e14861f2d9384bc2c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 161607,
"upload_time": "2025-10-22T08:28:00",
"upload_time_iso_8601": "2025-10-22T08:28:00.836942Z",
"url": "https://files.pythonhosted.org/packages/0d/a1/9cb4217a74fa20d89a48956fd719524465582fc43551303c70e764cd5fa1/codeviewx-0.2.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-10-22 08:28:00",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "dean2021",
"github_project": "codeviewx",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "annotated-types",
"specs": [
[
"==",
"0.7.0"
]
]
},
{
"name": "anthropic",
"specs": [
[
"==",
"0.70.0"
]
]
},
{
"name": "anyio",
"specs": [
[
"==",
"4.11.0"
]
]
},
{
"name": "certifi",
"specs": [
[
"==",
"2025.10.5"
]
]
},
{
"name": "charset-normalizer",
"specs": [
[
"==",
"3.4.4"
]
]
},
{
"name": "deepagents",
"specs": [
[
"==",
"0.0.5"
]
]
},
{
"name": "distro",
"specs": [
[
"==",
"1.9.0"
]
]
},
{
"name": "docstring_parser",
"specs": [
[
"==",
"0.17.0"
]
]
},
{
"name": "h11",
"specs": [
[
"==",
"0.16.0"
]
]
},
{
"name": "httpcore",
"specs": [
[
"==",
"1.0.9"
]
]
},
{
"name": "httpx",
"specs": [
[
"==",
"0.28.1"
]
]
},
{
"name": "idna",
"specs": [
[
"==",
"3.11"
]
]
},
{
"name": "iniconfig",
"specs": [
[
"==",
"2.1.0"
]
]
},
{
"name": "jiter",
"specs": [
[
"==",
"0.11.0"
]
]
},
{
"name": "jsonpatch",
"specs": [
[
"==",
"1.33"
]
]
},
{
"name": "jsonpointer",
"specs": [
[
"==",
"3.0.0"
]
]
},
{
"name": "langchain",
"specs": [
[
"==",
"0.3.27"
]
]
},
{
"name": "langchain-anthropic",
"specs": [
[
"==",
"0.3.22"
]
]
},
{
"name": "langchain-core",
"specs": [
[
"==",
"0.3.79"
]
]
},
{
"name": "langchain-text-splitters",
"specs": [
[
"==",
"0.3.11"
]
]
},
{
"name": "langgraph",
"specs": [
[
"==",
"0.6.10"
]
]
},
{
"name": "langgraph-checkpoint",
"specs": [
[
"==",
"2.1.2"
]
]
},
{
"name": "langgraph-prebuilt",
"specs": [
[
"==",
"0.6.4"
]
]
},
{
"name": "langgraph-sdk",
"specs": [
[
"==",
"0.2.9"
]
]
},
{
"name": "langsmith",
"specs": [
[
"==",
"0.4.34"
]
]
},
{
"name": "orjson",
"specs": [
[
"==",
"3.11.3"
]
]
},
{
"name": "ormsgpack",
"specs": [
[
"==",
"1.11.0"
]
]
},
{
"name": "packaging",
"specs": [
[
"==",
"25.0"
]
]
},
{
"name": "pluggy",
"specs": [
[
"==",
"1.6.0"
]
]
},
{
"name": "pydantic",
"specs": [
[
"==",
"2.12.2"
]
]
},
{
"name": "pydantic_core",
"specs": [
[
"==",
"2.41.4"
]
]
},
{
"name": "Pygments",
"specs": [
[
"==",
"2.19.2"
]
]
},
{
"name": "pytest",
"specs": [
[
"==",
"8.4.2"
]
]
},
{
"name": "PyYAML",
"specs": [
[
"==",
"6.0.3"
]
]
},
{
"name": "requests",
"specs": [
[
"==",
"2.32.5"
]
]
},
{
"name": "requests-toolbelt",
"specs": [
[
"==",
"1.0.0"
]
]
},
{
"name": "ripgrepy",
"specs": [
[
"==",
"2.2.0"
]
]
},
{
"name": "sniffio",
"specs": [
[
"==",
"1.3.1"
]
]
},
{
"name": "SQLAlchemy",
"specs": [
[
"==",
"2.0.44"
]
]
},
{
"name": "tenacity",
"specs": [
[
"==",
"9.1.2"
]
]
},
{
"name": "typing-inspection",
"specs": [
[
"==",
"0.4.2"
]
]
},
{
"name": "typing_extensions",
"specs": [
[
"==",
"4.15.0"
]
]
},
{
"name": "urllib3",
"specs": [
[
"==",
"2.5.0"
]
]
},
{
"name": "xxhash",
"specs": [
[
"==",
"3.6.0"
]
]
},
{
"name": "zstandard",
"specs": [
[
"==",
"0.25.0"
]
]
}
],
"lcname": "codeviewx"
}
JSON
