[](https://github.com/chigwell/penelopa)
[](https://www.gnu.org/licenses/agpl-3.0)
[](https://pepy.tech/project/penelopa)
[](https://pypi.org/project/penelopa/)
# Penelopa: AI-driven Codebase Modifier
Penelopa is an innovative tool designed to leverage OpenAI's GPT models for intelligent and automated codebase modifications. It comprehends and executes code changes based on natural language task descriptions, bringing a new level of efficiency to code maintenance.
## Installation
Install Penelopa easily using pip:
```bash
pip install penelopa
```
## Usage
Run Penelopa from the command line with various options:
```bash
penelopa --task=<task description>
--gpt_key=<OpenAI GPT key>
--config_path=<path to config>
--logging=<True/False>
--project=<project name>
--path=<project path>
--model=<GPT model>
--temperature=<float>
--top_p=<float>
--max_tokens=<int>
--gitignore=<True/False>
--listing=<path to listing file>
--updated_listing=<True/False>
--assistant_id=<assistant id>
```
### Arguments
- `--config_path`: Path to the YAML configuration file.
- `--logging`: Enable verbose logging (True/False).
- `--project`: Name of the project for contextual understanding.
- `--path`: Path to the project directory.
- `--task`: Description of the task for the AI to understand and perform.
- `--gpt_key`: API key for OpenAI services.
- `--model`: OpenAI GPT model to use.
- `--temperature`: Level of creativity for AI responses.
- `--top_p`: Diversity of AI responses.
- `--max_tokens`: Maximum word count for AI responses.
- `--gitignore`: Consider .gitignore rules (True/False).
- `--listing`: Path to project file listing for context.
- `--updated_listing`: Flag to update the listing file (True/False).
- `--assistant_id`: Identifier for the AI assistant instance.
## Contributing
Your contributions are welcome! Feel free to create [issue requests](https://github.com/chigwell/penelopa/issues) to enhance Penelopa's functionalities.
## License
This project is licensed under the [GNU Affero General Public License v3.0](https://www.gnu.org/licenses/agpl-3.0).
Raw data
{
"_id": null,
"home_page": "https://github.com/chigwell/penelopa",
"name": "penelopa",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "",
"author": "Eugene Evstafev",
"author_email": "chigwel@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/f9/fd/afc8d9ab77c1edc51659f6ba0486391e494700f1d5fa69d1c1c45040096c/penelopa-0.0.30.tar.gz",
"platform": null,
"description": "[](https://github.com/chigwell/penelopa)\n[](https://www.gnu.org/licenses/agpl-3.0)\n[](https://pepy.tech/project/penelopa)\n[](https://pypi.org/project/penelopa/)\n\n# Penelopa: AI-driven Codebase Modifier\n\nPenelopa is an innovative tool designed to leverage OpenAI's GPT models for intelligent and automated codebase modifications. It comprehends and executes code changes based on natural language task descriptions, bringing a new level of efficiency to code maintenance.\n\n\n\n## Installation\n\nInstall Penelopa easily using pip:\n\n```bash\npip install penelopa\n```\n\n## Usage\n\nRun Penelopa from the command line with various options:\n\n```bash\npenelopa --task=<task description> \n --gpt_key=<OpenAI GPT key>\n --config_path=<path to config> \n --logging=<True/False> \n --project=<project name> \n --path=<project path> \n --model=<GPT model> \n --temperature=<float> \n --top_p=<float> \n --max_tokens=<int> \n --gitignore=<True/False> \n --listing=<path to listing file> \n --updated_listing=<True/False> \n --assistant_id=<assistant id>\n```\n\n### Arguments\n\n- `--config_path`: Path to the YAML configuration file.\n- `--logging`: Enable verbose logging (True/False).\n- `--project`: Name of the project for contextual understanding.\n- `--path`: Path to the project directory.\n- `--task`: Description of the task for the AI to understand and perform.\n- `--gpt_key`: API key for OpenAI services.\n- `--model`: OpenAI GPT model to use.\n- `--temperature`: Level of creativity for AI responses.\n- `--top_p`: Diversity of AI responses.\n- `--max_tokens`: Maximum word count for AI responses.\n- `--gitignore`: Consider .gitignore rules (True/False).\n- `--listing`: Path to project file listing for context.\n- `--updated_listing`: Flag to update the listing file (True/False).\n- `--assistant_id`: Identifier for the AI assistant instance.\n\n## Contributing\n\nYour contributions are welcome! Feel free to create [issue requests](https://github.com/chigwell/penelopa/issues) to enhance Penelopa's functionalities.\n\n## License\n\nThis project is licensed under the [GNU Affero General Public License v3.0](https://www.gnu.org/licenses/agpl-3.0).\n\n\n",
"bugtrack_url": null,
"license": "",
"summary": "Penelopa: AI-driven codebase modifier using OpenAI GPT models",
"version": "0.0.30",
"project_urls": {
"Homepage": "https://github.com/chigwell/penelopa"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7116b3671931a2bd42d9502a8e78ad090c17a21c194f1306446eb70e67beff72",
"md5": "f03ab9bc6731edb19fae1ec7e7ed4532",
"sha256": "3dc3db71d17b85b2a63c5701f9ee4a1c0e3f9d71299e7dd661f29831a8b47f9e"
},
"downloads": -1,
"filename": "penelopa-0.0.30-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f03ab9bc6731edb19fae1ec7e7ed4532",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 10586,
"upload_time": "2024-01-20T18:47:03",
"upload_time_iso_8601": "2024-01-20T18:47:03.113319Z",
"url": "https://files.pythonhosted.org/packages/71/16/b3671931a2bd42d9502a8e78ad090c17a21c194f1306446eb70e67beff72/penelopa-0.0.30-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f9fdafc8d9ab77c1edc51659f6ba0486391e494700f1d5fa69d1c1c45040096c",
"md5": "3f42bc3b9742f189c1ba4c418c81f3f3",
"sha256": "c3fd8dda9926ebd27d3df55e292621fb3c169e81ea1f86b9020bc12d07aa6087"
},
"downloads": -1,
"filename": "penelopa-0.0.30.tar.gz",
"has_sig": false,
"md5_digest": "3f42bc3b9742f189c1ba4c418c81f3f3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 10511,
"upload_time": "2024-01-20T18:47:11",
"upload_time_iso_8601": "2024-01-20T18:47:11.695792Z",
"url": "https://files.pythonhosted.org/packages/f9/fd/afc8d9ab77c1edc51659f6ba0486391e494700f1d5fa69d1c1c45040096c/penelopa-0.0.30.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-20 18:47:11",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "chigwell",
"github_project": "penelopa",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "penelopa"
}
JSON
