| Name | codemapper JSON |
| Version |
4.4.0
JSON |
| download |
| home_page | None |
| Summary | A tool to generate comprehensive Markdown artifacts of directory structures and file contents |
| upload_time | 2024-12-30 02:33:47 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10 |
| license | MIT License Copyright (c) 2024 Shane Holloman 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. |
| keywords |
codemapper
markdown
directory
file contents
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
pathspec
chardet
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# CodeMapper
[](https://github.com/shaneholloman/codemapper/actions/workflows/pylint.yml)
[](https://github.com/shaneholloman/codemapper/actions/workflows/pytest.yml)
[](docs/todo.md)
[](docs/todo.md)
<!-- TOC -->
- [CodeMapper](#codemapper)
- [Overview](#overview)
- [Key Features](#key-features)
- [AI Chat Integration](#ai-chat-integration)
- [Use Cases](#use-cases)
- [For AI Engineers](#for-ai-engineers)
- [For Hobbyists](#for-hobbyists)
- [Getting Started](#getting-started)
- [Example Output](#example-output)
- [Future Development](#future-development)
- [Target Audiences](#target-audiences)
- [AI Engineers Will Appreciate](#ai-engineers-will-appreciate)
- [Hobbyists Will Value](#hobbyists-will-value)
- [Installation Options](#installation-options)
- [Contributing](#contributing)
- [Resources](#resources)
- [License](#license)
- [Acknowledgments](#acknowledgments)
- [Version History](#version-history)
<!-- /TOC -->
## Overview
> [!IMPORTANT]
> CodeMapper: Bridging Code Understanding for AI and Human Analysis
>
> Install: `pip install codemapper`
CodeMapper is a powerful Python tool that transforms complex codebases into navigable, single-file Markdown artifacts, with a unique ability to bootstrap AI chat prompts for code analysis. Designed with both AI engineers and hobbyist developers in mind, it serves as a bridge between traditional code exploration and modern AI-assisted development workflows. Whether you're training large language models, conducting interactive AI-assisted code reviews, or simply trying to understand a new project, CodeMapper provides a unified, accessible view of your codebase that's optimized for both human readability and AI consumption.
## Key Features
- **Unified Code Visualization**: Automatically generates a comprehensive Markdown representation of your entire codebase, including:
- Complete directory structure visualization
- Syntax-highlighted code content
- Intelligent file categorization
- Documentation aggregation
- **AI Integration Optimizations**:
- Structured output format ideal for LLM training and analysis
- Consistent formatting for improved token efficiency
- Built-in support for common documentation patterns
- Metadata preservation for enhanced context
- **Git-Aware Processing**:
- Respects `.gitignore` rules by default
- Direct GitHub repository URL support
- Handles large repositories efficiently
- Smart binary file detection
- **Documentation Focus**:
- Dedicated DocMap generation for documentation-heavy projects
- README file prioritization
- Support for multiple documentation directory conventions
- Markdown-native output for universal compatibility
## AI Chat Integration
CodeMapper excels at bootstrapping AI chat interactions for code analysis. When you need to understand, debug, or enhance your code with AI assistance:
1. Generate a codemap of your project
2. Copy the generated markdown into your AI chat
3. Start asking detailed questions about your codebase
The AI assistant receives:
- Complete project structure
- All file contents with proper syntax highlighting
- Documentation in context
- Clear navigation structure
This enables the AI to provide more accurate, contextual responses about your code without manual file copying or context limitations.
## Use Cases
### For AI Engineers
- **AI Chat Prompt Bootstrapping**: Instantly generate context-rich prompts for AI chat interactions about your code
- **Interactive Code Analysis**: Seamlessly feed comprehensive codebase context to AI assistants
- **Training Data Preparation**: Generate consistently formatted codebase representations for model training
- **Documentation Generation**: Train models on well-structured documentation patterns
- **Code Understanding**: Feed entire codebases to LLMs for comprehensive analysis
> [!TIP]
> Example AI Chat Workflow:
```bash
# Generate a codemap for your project
codemapper /path/to/project_or_repo
# The generated codemap can be directly used in AI chat prompts:
"Here's my project structure and code, help me understand the dependency flow:
[paste or add to you project knowledge *_codemap.md content]"
```
### For Hobbyists
- **Project Exploration**: Quickly understand new codebases without complex IDE setup
- **Documentation Creation**: Generate comprehensive project documentation automatically
- **Code Reviews**: Facilitate easier code reviews with a unified view
- **Learning Tool**: Study and understand how different projects are structured
## Getting Started
```bash
# Install from PyPI
pip install codemapper
# Basic usage
codemapper /path/to/project
# Generate documentation map
codemapper --docs /path/to/project
# Process GitHub repository
codemapper https://github.com/username/repo
```
## Example Output
CodeMapper generates two main types of outputs:
1. **CodeMap** (`project_codemap.md`):
- Complete directory tree
- File contents with syntax highlighting
- Smart handling of binary and large files
- Navigation-optimized structure
2. **DocMap** (`project_docmap.md`):
- Documentation-focused view
- README files
- Documentation directory contents
- Structured for easy consumption
## Future Development
> [!NOTE]
> CodeMapper welcomes help while actively focused on:
[ToDos](docs/todo.md)
- Expanded format support (XML, JSON, YAML, RST)
- Enhanced AI integration capabilities
- Real-time code change tracking
- Collaborative annotation features
- Intelligent code pattern recognition
- API access for programmatic integration
## Target Audiences
### AI Engineers Will Appreciate
- Consistent, clean output format for training data
- Efficient handling of large repositories
- Structured metadata preservation
- Integration-ready design
### Hobbyists Will Value
- Simple, straightforward installation
- Clear, readable output
- No complex configuration required
- Immediate utility for project understanding
## Installation Options
```bash
# For basic installation
pip install codemapper
# For development installation
git clone https://github.com/shaneholloman/codemapper
cd codemapper
pip install -e .
```
## Contributing
CodeMapper welcomes contributions from both AI engineers and hobbyist developers. The project maintains a balance between sophisticated features for AI integration and accessibility for general use.
Visit the [GitHub repository](https://github.com/shaneholloman/codemapper) to:
- Report issues
- Submit feature requests
- Contribute code
- Join the discussion
## Resources
- [GitHub Repository](https://github.com/shaneholloman/codemapper)
- [PyPI Package](https://pypi.org/project/codemapper/)
- [Issue Tracker](https://github.com/shaneholloman/codemapper/issues)
- [Changelog](https://github.com/shaneholloman/codemapper/blob/main/changelog.md)
CodeMapper represents a bridge between traditional code exploration and modern AI-assisted development, making codebases more accessible and understandable for everyone from AI researchers to hobbyist developers.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
## Acknowledgments
- Thanks to the `pathspec` and `chardet` libraries for enhancing CodeMapper's functionality.
## Version History
For a detailed version history, please refer to the [changelog.md](changelog.md).
---
If you find CodeMapper useful, don't forget to star this repository!
Raw data
{
"_id": null,
"home_page": null,
"name": "codemapper",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "codemapper, markdown, directory, file contents",
"author": null,
"author_email": "Shane Holloman <shaneholloman@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/bf/aa/127d2d3c72ddd9ffa5026a4ef2842d21080a456b76281049d66e5789648a/codemapper-4.4.0.tar.gz",
"platform": null,
"description": "# CodeMapper\r\n\r\n[](https://github.com/shaneholloman/codemapper/actions/workflows/pylint.yml)\r\n[](https://github.com/shaneholloman/codemapper/actions/workflows/pytest.yml)\r\n[](docs/todo.md)\r\n[](docs/todo.md)\r\n\r\n\r\n\r\n<!-- TOC -->\r\n\r\n- [CodeMapper](#codemapper)\r\n - [Overview](#overview)\r\n - [Key Features](#key-features)\r\n - [AI Chat Integration](#ai-chat-integration)\r\n - [Use Cases](#use-cases)\r\n - [For AI Engineers](#for-ai-engineers)\r\n - [For Hobbyists](#for-hobbyists)\r\n - [Getting Started](#getting-started)\r\n - [Example Output](#example-output)\r\n - [Future Development](#future-development)\r\n - [Target Audiences](#target-audiences)\r\n - [AI Engineers Will Appreciate](#ai-engineers-will-appreciate)\r\n - [Hobbyists Will Value](#hobbyists-will-value)\r\n - [Installation Options](#installation-options)\r\n - [Contributing](#contributing)\r\n - [Resources](#resources)\r\n - [License](#license)\r\n - [Acknowledgments](#acknowledgments)\r\n - [Version History](#version-history)\r\n\r\n<!-- /TOC -->\r\n\r\n## Overview\r\n\r\n> [!IMPORTANT]\r\n> CodeMapper: Bridging Code Understanding for AI and Human Analysis\r\n>\r\n> Install: `pip install codemapper`\r\n\r\nCodeMapper is a powerful Python tool that transforms complex codebases into navigable, single-file Markdown artifacts, with a unique ability to bootstrap AI chat prompts for code analysis. Designed with both AI engineers and hobbyist developers in mind, it serves as a bridge between traditional code exploration and modern AI-assisted development workflows. Whether you're training large language models, conducting interactive AI-assisted code reviews, or simply trying to understand a new project, CodeMapper provides a unified, accessible view of your codebase that's optimized for both human readability and AI consumption.\r\n\r\n## Key Features\r\n\r\n- **Unified Code Visualization**: Automatically generates a comprehensive Markdown representation of your entire codebase, including:\r\n - Complete directory structure visualization\r\n - Syntax-highlighted code content\r\n - Intelligent file categorization\r\n - Documentation aggregation\r\n\r\n- **AI Integration Optimizations**:\r\n - Structured output format ideal for LLM training and analysis\r\n - Consistent formatting for improved token efficiency\r\n - Built-in support for common documentation patterns\r\n - Metadata preservation for enhanced context\r\n\r\n- **Git-Aware Processing**:\r\n - Respects `.gitignore` rules by default\r\n - Direct GitHub repository URL support\r\n - Handles large repositories efficiently\r\n - Smart binary file detection\r\n\r\n- **Documentation Focus**:\r\n - Dedicated DocMap generation for documentation-heavy projects\r\n - README file prioritization\r\n - Support for multiple documentation directory conventions\r\n - Markdown-native output for universal compatibility\r\n\r\n## AI Chat Integration\r\n\r\nCodeMapper excels at bootstrapping AI chat interactions for code analysis. When you need to understand, debug, or enhance your code with AI assistance:\r\n\r\n1. Generate a codemap of your project\r\n2. Copy the generated markdown into your AI chat\r\n3. Start asking detailed questions about your codebase\r\n\r\nThe AI assistant receives:\r\n\r\n- Complete project structure\r\n- All file contents with proper syntax highlighting\r\n- Documentation in context\r\n- Clear navigation structure\r\n\r\nThis enables the AI to provide more accurate, contextual responses about your code without manual file copying or context limitations.\r\n\r\n## Use Cases\r\n\r\n### For AI Engineers\r\n\r\n- **AI Chat Prompt Bootstrapping**: Instantly generate context-rich prompts for AI chat interactions about your code\r\n- **Interactive Code Analysis**: Seamlessly feed comprehensive codebase context to AI assistants\r\n- **Training Data Preparation**: Generate consistently formatted codebase representations for model training\r\n- **Documentation Generation**: Train models on well-structured documentation patterns\r\n- **Code Understanding**: Feed entire codebases to LLMs for comprehensive analysis\r\n\r\n> [!TIP]\r\n> Example AI Chat Workflow:\r\n\r\n```bash\r\n# Generate a codemap for your project\r\ncodemapper /path/to/project_or_repo\r\n\r\n# The generated codemap can be directly used in AI chat prompts:\r\n\"Here's my project structure and code, help me understand the dependency flow:\r\n[paste or add to you project knowledge *_codemap.md content]\"\r\n```\r\n\r\n### For Hobbyists\r\n\r\n- **Project Exploration**: Quickly understand new codebases without complex IDE setup\r\n- **Documentation Creation**: Generate comprehensive project documentation automatically\r\n- **Code Reviews**: Facilitate easier code reviews with a unified view\r\n- **Learning Tool**: Study and understand how different projects are structured\r\n\r\n## Getting Started\r\n\r\n```bash\r\n# Install from PyPI\r\npip install codemapper\r\n\r\n# Basic usage\r\ncodemapper /path/to/project\r\n\r\n# Generate documentation map\r\ncodemapper --docs /path/to/project\r\n\r\n# Process GitHub repository\r\ncodemapper https://github.com/username/repo\r\n```\r\n\r\n## Example Output\r\n\r\nCodeMapper generates two main types of outputs:\r\n\r\n1. **CodeMap** (`project_codemap.md`):\r\n - Complete directory tree\r\n - File contents with syntax highlighting\r\n - Smart handling of binary and large files\r\n - Navigation-optimized structure\r\n\r\n2. **DocMap** (`project_docmap.md`):\r\n - Documentation-focused view\r\n - README files\r\n - Documentation directory contents\r\n - Structured for easy consumption\r\n\r\n## Future Development\r\n\r\n> [!NOTE]\r\n> CodeMapper welcomes help while actively focused on:\r\n\r\n[ToDos](docs/todo.md)\r\n\r\n- Expanded format support (XML, JSON, YAML, RST)\r\n- Enhanced AI integration capabilities\r\n- Real-time code change tracking\r\n- Collaborative annotation features\r\n- Intelligent code pattern recognition\r\n- API access for programmatic integration\r\n\r\n## Target Audiences\r\n\r\n### AI Engineers Will Appreciate\r\n\r\n- Consistent, clean output format for training data\r\n- Efficient handling of large repositories\r\n- Structured metadata preservation\r\n- Integration-ready design\r\n\r\n### Hobbyists Will Value\r\n\r\n- Simple, straightforward installation\r\n- Clear, readable output\r\n- No complex configuration required\r\n- Immediate utility for project understanding\r\n\r\n## Installation Options\r\n\r\n```bash\r\n# For basic installation\r\npip install codemapper\r\n\r\n# For development installation\r\ngit clone https://github.com/shaneholloman/codemapper\r\ncd codemapper\r\npip install -e .\r\n```\r\n\r\n## Contributing\r\n\r\nCodeMapper welcomes contributions from both AI engineers and hobbyist developers. The project maintains a balance between sophisticated features for AI integration and accessibility for general use.\r\n\r\nVisit the [GitHub repository](https://github.com/shaneholloman/codemapper) to:\r\n\r\n- Report issues\r\n- Submit feature requests\r\n- Contribute code\r\n- Join the discussion\r\n\r\n## Resources\r\n\r\n- [GitHub Repository](https://github.com/shaneholloman/codemapper)\r\n- [PyPI Package](https://pypi.org/project/codemapper/)\r\n- [Issue Tracker](https://github.com/shaneholloman/codemapper/issues)\r\n- [Changelog](https://github.com/shaneholloman/codemapper/blob/main/changelog.md)\r\n\r\nCodeMapper represents a bridge between traditional code exploration and modern AI-assisted development, making codebases more accessible and understandable for everyone from AI researchers to hobbyist developers.\r\n\r\n## License\r\n\r\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\r\n\r\n## Acknowledgments\r\n\r\n- Thanks to the `pathspec` and `chardet` libraries for enhancing CodeMapper's functionality.\r\n\r\n## Version History\r\n\r\nFor a detailed version history, please refer to the [changelog.md](changelog.md).\r\n\r\n---\r\n\r\nIf you find CodeMapper useful, don't forget to star this repository!\r\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2024 Shane Holloman 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. ",
"summary": "A tool to generate comprehensive Markdown artifacts of directory structures and file contents",
"version": "4.4.0",
"project_urls": {
"Homepage": "https://github.com/shaneholloman/codemapper"
},
"split_keywords": [
"codemapper",
" markdown",
" directory",
" file contents"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "afad7d5d850b3aa869f549613aad3702e8dbf5a554478fc6f84c74936a09a6b1",
"md5": "1f47a04cad71ff0b2d20b8744df4333f",
"sha256": "f4ca0f8f318b798ae2002c550c645e778fd8b44531943a2bc1bfd52a700cdb23"
},
"downloads": -1,
"filename": "codemapper-4.4.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1f47a04cad71ff0b2d20b8744df4333f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 15958,
"upload_time": "2024-12-30T02:33:44",
"upload_time_iso_8601": "2024-12-30T02:33:44.964042Z",
"url": "https://files.pythonhosted.org/packages/af/ad/7d5d850b3aa869f549613aad3702e8dbf5a554478fc6f84c74936a09a6b1/codemapper-4.4.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "bfaa127d2d3c72ddd9ffa5026a4ef2842d21080a456b76281049d66e5789648a",
"md5": "550786b98d55f98630fc38bbd38de73d",
"sha256": "1346bcb3b75a055dbc26d49acca10c96fe815cac38d9f4d00273f0ddfa10f56e"
},
"downloads": -1,
"filename": "codemapper-4.4.0.tar.gz",
"has_sig": false,
"md5_digest": "550786b98d55f98630fc38bbd38de73d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 19106,
"upload_time": "2024-12-30T02:33:47",
"upload_time_iso_8601": "2024-12-30T02:33:47.728205Z",
"url": "https://files.pythonhosted.org/packages/bf/aa/127d2d3c72ddd9ffa5026a4ef2842d21080a456b76281049d66e5789648a/codemapper-4.4.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-30 02:33:47",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "shaneholloman",
"github_project": "codemapper",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "pathspec",
"specs": [
[
">=",
"0.9.0"
]
]
},
{
"name": "chardet",
"specs": [
[
">=",
"4.0.0"
]
]
}
],
"lcname": "codemapper"
}
