Skip to main content

Penelopa: AI-driven codebase modifier using OpenAI GPT models

Project description

GitHub top language License: AGPL v3 Downloads PyPI - Version

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.

Penelopa

Installation

Install Penelopa easily using pip:

pip install penelopa

Usage

Run Penelopa from the command line with various options:

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 to enhance Penelopa's functionalities.

License

This project is licensed under the GNU Affero General Public License v3.0.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

penelopa-0.0.30.tar.gz (10.5 kB view details)

Uploaded Source

Built Distribution

penelopa-0.0.30-py3-none-any.whl (10.6 kB view details)

Uploaded Python 3

File details

Details for the file penelopa-0.0.30.tar.gz.

File metadata

  • Download URL: penelopa-0.0.30.tar.gz
  • Upload date:
  • Size: 10.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.8.3

File hashes

Hashes for penelopa-0.0.30.tar.gz
Algorithm Hash digest
SHA256 c3fd8dda9926ebd27d3df55e292621fb3c169e81ea1f86b9020bc12d07aa6087
MD5 3f42bc3b9742f189c1ba4c418c81f3f3
BLAKE2b-256 f9fdafc8d9ab77c1edc51659f6ba0486391e494700f1d5fa69d1c1c45040096c

See more details on using hashes here.

File details

Details for the file penelopa-0.0.30-py3-none-any.whl.

File metadata

  • Download URL: penelopa-0.0.30-py3-none-any.whl
  • Upload date:
  • Size: 10.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.8.3

File hashes

Hashes for penelopa-0.0.30-py3-none-any.whl
Algorithm Hash digest
SHA256 3dc3db71d17b85b2a63c5701f9ee4a1c0e3f9d71299e7dd661f29831a8b47f9e
MD5 f03ab9bc6731edb19fae1ec7e7ed4532
BLAKE2b-256 7116b3671931a2bd42d9502a8e78ad090c17a21c194f1306446eb70e67beff72

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page