# Code Collator
Code Collator is a powerful CLI tool designed to streamline your code review and documentation process by collating your entire codebase into a single, organised Markdown file. This is particularly useful for sharing with AI tools like ChatGPT or Claude for analysis, troubleshooting, or documentation.
## Use Case
Have you ever needed to provide a comprehensive overview of your codebase for a code review, AI analysis, or detailed documentation? Code Collator simplifies this task by aggregating all your code files into a single Markdown file. This makes it easy to:
- Share your code with AI tools like ChatGPT or Claude for intelligent analysis.
- Generate a unified document for code reviews or team collaboration.
- Create comprehensive documentation for your projects with minimal effort.
## Features
- **Full Codebase Collation**: Collates all files in the specified directory and subdirectories into one Markdown file.
- **.gitignore Support**: Automatically ignores files specified in the `.gitignore` file if one exists.
- **Customizable Output**: Outputs a single Markdown file named `collated-code.md` by default, with options to specify the path to the codebase directory and output file name.
- **Binary File Inclusion**: Includes binary files such as images in the output with a note about their file type.
- **Comment Exclusion Option**: Allows users to exclude comments and docstrings from the collated code.
- **Help Command**: Provides a help command to display usage instructions.
## Demo Video
[)](https://youtu.be/e8Ep_NOi_xU)
*Click the image above to watch a hands-on demo of how Code Collator works.*
## Installation
You can easily install Code Collator using pip:
```sh
pip install code-collator
Raw data
{
"_id": null,
"home_page": "https://github.com/tawanda-kembo/code-collator",
"name": "code-collator",
"maintainer": null,
"docs_url": null,
"requires_python": "<4,>=3.6",
"maintainer_email": null,
"keywords": "cli, development, documentation",
"author": "Tawanda Kembo",
"author_email": "tawanda@mrkembo.com",
"download_url": "https://files.pythonhosted.org/packages/f7/5e/3933c810013cbb7260842838c990c612b3173d864e0703be540870d79b01/code_collator-0.20.0.tar.gz",
"platform": null,
"description": "# Code Collator\n\nCode Collator is a powerful CLI tool designed to streamline your code review and documentation process by collating your entire codebase into a single, organised Markdown file. This is particularly useful for sharing with AI tools like ChatGPT or Claude for analysis, troubleshooting, or documentation.\n\n## Use Case\n\nHave you ever needed to provide a comprehensive overview of your codebase for a code review, AI analysis, or detailed documentation? Code Collator simplifies this task by aggregating all your code files into a single Markdown file. This makes it easy to:\n\n- Share your code with AI tools like ChatGPT or Claude for intelligent analysis.\n- Generate a unified document for code reviews or team collaboration.\n- Create comprehensive documentation for your projects with minimal effort.\n\n## Features\n\n- **Full Codebase Collation**: Collates all files in the specified directory and subdirectories into one Markdown file.\n- **.gitignore Support**: Automatically ignores files specified in the `.gitignore` file if one exists.\n- **Customizable Output**: Outputs a single Markdown file named `collated-code.md` by default, with options to specify the path to the codebase directory and output file name.\n- **Binary File Inclusion**: Includes binary files such as images in the output with a note about their file type.\n- **Comment Exclusion Option**: Allows users to exclude comments and docstrings from the collated code.\n- **Help Command**: Provides a help command to display usage instructions.\n\n## Demo Video\n\n[)](https://youtu.be/e8Ep_NOi_xU)\n\n*Click the image above to watch a hands-on demo of how Code Collator works.*\n\n## Installation\n\nYou can easily install Code Collator using pip:\n\n```sh\npip install code-collator\n",
"bugtrack_url": null,
"license": null,
"summary": "A CLI tool to aggregate codebase into a single Markdown file",
"version": "0.20.0",
"project_urls": {
"Bug Reports": "https://github.com/tawanda-kembo/code-collator/issues",
"Homepage": "https://github.com/tawanda-kembo/code-collator",
"Source": "https://github.com/tawanda-kembo/code-collator"
},
"split_keywords": [
"cli",
" development",
" documentation"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2560c4e4e39feae6876a99499251c09bfdfefdee5536c05e8c8d33332d0d6181",
"md5": "421c9b8663e92a51487120bbbebdc05d",
"sha256": "84a51d737385ee7759cbeb2e1810120a9191008494a65203ccb4e6cafdfd11c3"
},
"downloads": -1,
"filename": "code_collator-0.20.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "421c9b8663e92a51487120bbbebdc05d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4,>=3.6",
"size": 4928,
"upload_time": "2024-10-09T18:35:08",
"upload_time_iso_8601": "2024-10-09T18:35:08.189916Z",
"url": "https://files.pythonhosted.org/packages/25/60/c4e4e39feae6876a99499251c09bfdfefdee5536c05e8c8d33332d0d6181/code_collator-0.20.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f75e3933c810013cbb7260842838c990c612b3173d864e0703be540870d79b01",
"md5": "9424e9b15575609ca516fbc988ac0396",
"sha256": "3d92c96cbdf3c9dbcb699d34550f4dbb09cfe7454bbc230450ab010042c51cf3"
},
"downloads": -1,
"filename": "code_collator-0.20.0.tar.gz",
"has_sig": false,
"md5_digest": "9424e9b15575609ca516fbc988ac0396",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4,>=3.6",
"size": 5383,
"upload_time": "2024-10-09T18:35:09",
"upload_time_iso_8601": "2024-10-09T18:35:09.682995Z",
"url": "https://files.pythonhosted.org/packages/f7/5e/3933c810013cbb7260842838c990c612b3173d864e0703be540870d79b01/code_collator-0.20.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-09 18:35:09",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "tawanda-kembo",
"github_project": "code-collator",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "code-collator",
"specs": []
},
{
"name": "Pygments",
"specs": [
[
"==",
"2.18.0"
]
]
},
{
"name": "certifi",
"specs": [
[
"==",
"2024.7.4"
]
]
},
{
"name": "charset-normalizer",
"specs": [
[
"==",
"3.3.2"
]
]
},
{
"name": "coverage",
"specs": [
[
"==",
"7.6.0"
]
]
},
{
"name": "docutils",
"specs": [
[
"==",
"0.21.2"
]
]
},
{
"name": "flake8",
"specs": [
[
"==",
"7.1.0"
]
]
},
{
"name": "idna",
"specs": [
[
"==",
"3.7"
]
]
},
{
"name": "importlib_metadata",
"specs": [
[
"==",
"8.2.0"
]
]
},
{
"name": "iniconfig",
"specs": [
[
"==",
"2.0.0"
]
]
},
{
"name": "jaraco.classes",
"specs": [
[
"==",
"3.4.0"
]
]
},
{
"name": "jaraco.context",
"specs": [
[
"==",
"5.3.0"
]
]
},
{
"name": "jaraco.functools",
"specs": [
[
"==",
"4.0.1"
]
]
},
{
"name": "keyring",
"specs": [
[
"==",
"25.2.1"
]
]
},
{
"name": "markdown-it-py",
"specs": [
[
"==",
"3.0.0"
]
]
},
{
"name": "mccabe",
"specs": [
[
"==",
"0.7.0"
]
]
},
{
"name": "mdurl",
"specs": [
[
"==",
"0.1.2"
]
]
},
{
"name": "more-itertools",
"specs": [
[
"==",
"10.3.0"
]
]
},
{
"name": "nh3",
"specs": [
[
"==",
"0.2.18"
]
]
},
{
"name": "packaging",
"specs": [
[
"==",
"24.1"
]
]
},
{
"name": "pkginfo",
"specs": [
[
"==",
"1.10.0"
]
]
},
{
"name": "pluggy",
"specs": [
[
"==",
"1.5.0"
]
]
},
{
"name": "pycodestyle",
"specs": [
[
"==",
"2.12.0"
]
]
},
{
"name": "pyflakes",
"specs": [
[
"==",
"3.2.0"
]
]
},
{
"name": "pytest",
"specs": [
[
"==",
"8.3.2"
]
]
},
{
"name": "pytest-cov",
"specs": [
[
"==",
"5.0.0"
]
]
},
{
"name": "readme_renderer",
"specs": [
[
"==",
"44.0"
]
]
},
{
"name": "requests",
"specs": [
[
"==",
"2.32.3"
]
]
},
{
"name": "requests-toolbelt",
"specs": [
[
"==",
"1.0.0"
]
]
},
{
"name": "rfc3986",
"specs": [
[
"==",
"2.0.0"
]
]
},
{
"name": "rich",
"specs": [
[
"==",
"13.7.1"
]
]
},
{
"name": "setuptools",
"specs": [
[
"==",
"71.1.0"
]
]
},
{
"name": "twine",
"specs": [
[
"==",
"5.1.1"
]
]
},
{
"name": "urllib3",
"specs": [
[
"==",
"2.2.2"
]
]
},
{
"name": "wheel",
"specs": [
[
"==",
"0.43.0"
]
]
},
{
"name": "zipp",
"specs": [
[
"==",
"3.19.2"
]
]
},
{
"name": "autopep8",
"specs": [
[
"==",
"2.3.1"
]
]
}
],
"lcname": "code-collator"
}
JSON
