| Name | aicodeprep JSON |
| Version |
0.2.1
JSON |
| download |
| home_page | None |
| Summary | Prepare code for AI chatbot assistance |
| upload_time | 2024-11-02 21:05:30 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.6 |
| license | MIT License Copyright (c) 2024 DetroitTommy 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 |
ai
code
preparation
chatbot
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# aicodeprep (AI Code Prep)
aicodeprep is a command-line tool designed to simplify the process of sharing your project's code with AI chatbots. It recursively scans your project directory, concatenates all code files into a single text file, and copies the content to your clipboard for easy pasting into a LLM chat.
## Purpose
The primary purpose of aicodeprep is to save time when you need to ask AI chatbots questions about your development project. Instead of manually copying and pasting multiple files, aicodeprep automates the process of gathering all your project's code into a single, easily shareable format.
## Windows Installation
You can install aicodeprep directly from PyPI:
pip install aicodeprep
## Linux Installation (Debian / Ubuntu / Mint)
pip install --user aicodeprep
sudo apt-get install xclip
echo 'export PATH="$PATH:$HOME/.local/bin"' >> ~/.bashrc
source ~/.bashrc
## Linux Installation (Fedora)
pip install --user aicodeprep
sudo dnf install xclip
echo 'export PATH="$PATH:$HOME/.local/bin"' >> ~/.bashrc
source ~/.bashrc
***xclip is needed in Linux for the clipboard functionality***
## Usage
After installation, you can run aicodeprep from any directory containing your project files and folders:
aicodeprep
This will create a file named `fullcode.txt` in the current directory and copy its contents to your clipboard.
### Options
- `-n, --no-copy`: Do NOT copy output to clipboard (default behavior is to copy)
- `-o FILENAME, --output FILENAME`: Specify the output file name (default: fullcode.txt)
Example:
aicodeprep -n -o my_project_code.txt
This will create `my_project_code.txt` without copying to clipboard.
## Configuration
You can customize aicodeprep's behavior by creating a `aicodeprep_config.yaml` file in your project directory. Here's an example:
code_extensions:
- .py
- .js
- .html
exclude_dirs:
- node_modules
- venv
max_file_size: 500000 # in bytes
Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
License
This project is licensed under the MIT License.
Raw data
{
"_id": null,
"home_page": null,
"name": "aicodeprep",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": "ai, code, preparation, chatbot",
"author": null,
"author_email": "Tom Brothers <wuu73@yahoo.com>",
"download_url": "https://files.pythonhosted.org/packages/e4/0e/8bda4a29fbecf8515bfa1b5af1ff5538a663675ae1bd9e573a9bec7c4676/aicodeprep-0.2.1.tar.gz",
"platform": null,
"description": "# aicodeprep (AI Code Prep)\r\n\r\naicodeprep is a command-line tool designed to simplify the process of sharing your project's code with AI chatbots. It recursively scans your project directory, concatenates all code files into a single text file, and copies the content to your clipboard for easy pasting into a LLM chat.\r\n\r\n## Purpose\r\n\r\nThe primary purpose of aicodeprep is to save time when you need to ask AI chatbots questions about your development project. Instead of manually copying and pasting multiple files, aicodeprep automates the process of gathering all your project's code into a single, easily shareable format.\r\n\r\n## Windows Installation\r\n\r\nYou can install aicodeprep directly from PyPI:\r\n\r\npip install aicodeprep\r\n\r\n## Linux Installation (Debian / Ubuntu / Mint)\r\n\r\npip install --user aicodeprep\r\n\r\nsudo apt-get install xclip\r\n\r\necho 'export PATH=\"$PATH:$HOME/.local/bin\"' >> ~/.bashrc\r\n\r\nsource ~/.bashrc\r\n\r\n## Linux Installation (Fedora)\r\n\r\npip install --user aicodeprep\r\n\r\nsudo dnf install xclip\r\n\r\necho 'export PATH=\"$PATH:$HOME/.local/bin\"' >> ~/.bashrc\r\n\r\nsource ~/.bashrc\r\n\r\n***xclip is needed in Linux for the clipboard functionality***\r\n\r\n## Usage\r\n\r\nAfter installation, you can run aicodeprep from any directory containing your project files and folders:\r\n\r\naicodeprep\r\n\r\nThis will create a file named `fullcode.txt` in the current directory and copy its contents to your clipboard.\r\n\r\n\r\n\r\n\r\n### Options\r\n\r\n- `-n, --no-copy`: Do NOT copy output to clipboard (default behavior is to copy)\r\n- `-o FILENAME, --output FILENAME`: Specify the output file name (default: fullcode.txt)\r\n\r\nExample:\r\n\r\naicodeprep -n -o my_project_code.txt\r\n\r\nThis will create `my_project_code.txt` without copying to clipboard.\r\n\r\n## Configuration\r\n\r\nYou can customize aicodeprep's behavior by creating a `aicodeprep_config.yaml` file in your project directory. Here's an example:\r\n\r\ncode_extensions:\r\n - .py\r\n - .js\r\n - .html\r\nexclude_dirs:\r\n - node_modules\r\n - venv\r\nmax_file_size: 500000 # in bytes\r\n\r\nContributing\r\n\r\nContributions are welcome! Please feel free to submit a Pull Request.\r\n\r\nLicense\r\n\r\nThis project is licensed under the MIT License.\r\n\r\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2024 DetroitTommy 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": "Prepare code for AI chatbot assistance",
"version": "0.2.1",
"project_urls": {
"Homepage": "https://github.com/detroittommy879/aicodeprep"
},
"split_keywords": [
"ai",
" code",
" preparation",
" chatbot"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0823a068cab2d4a8b02e2880babe1e6210405faa4016d3c832d06930057102b1",
"md5": "877f1f3fd28c4699f12232d085248290",
"sha256": "f2b0916590816127195a2eb4b5e75e66398da4deee30cb55bd55db6a56ac06c1"
},
"downloads": -1,
"filename": "aicodeprep-0.2.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "877f1f3fd28c4699f12232d085248290",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 7315,
"upload_time": "2024-11-02T21:05:28",
"upload_time_iso_8601": "2024-11-02T21:05:28.785519Z",
"url": "https://files.pythonhosted.org/packages/08/23/a068cab2d4a8b02e2880babe1e6210405faa4016d3c832d06930057102b1/aicodeprep-0.2.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e40e8bda4a29fbecf8515bfa1b5af1ff5538a663675ae1bd9e573a9bec7c4676",
"md5": "200db6373a6df2b5cb948828e7a345e1",
"sha256": "b4caef355d69da1a9a12c993b6be3f319f3ac5ac333fb9e858e6a0bfca2a94e6"
},
"downloads": -1,
"filename": "aicodeprep-0.2.1.tar.gz",
"has_sig": false,
"md5_digest": "200db6373a6df2b5cb948828e7a345e1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 6119,
"upload_time": "2024-11-02T21:05:30",
"upload_time_iso_8601": "2024-11-02T21:05:30.001812Z",
"url": "https://files.pythonhosted.org/packages/e4/0e/8bda4a29fbecf8515bfa1b5af1ff5538a663675ae1bd9e573a9bec7c4676/aicodeprep-0.2.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-02 21:05:30",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "detroittommy879",
"github_project": "aicodeprep",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "aicodeprep"
}
