Skip to main content

Review an item using OpenAI.

Project description

Cururo: Automated Review Tool

Description

Based on Condor (automated PR review tool) this tool leverages the power of generative AI to offer insightful and constructive feedback. This CLI software is designed to facilitate item reviews using OpenAI's services. It allows users to specify an item for review, authenticate with OpenAI, and customize the review process through various command-line arguments.

Features

  • AI-Powered Review Process: Cururo uses generative AI to offer constructive criticism and suggestions.
  • CI/CD Integration (Coming Soon): Cururo will soon support integration with Continuous Integration/Continuous Deployment (CI/CD) systems, allowing automated reviews to be triggered by events such as PR creation or code push.

Usage

To use Cururo, you must have an OpenAI API key. You can obtain an API key by signing up for an account on the OpenAI website.

To run Cururo, you need to specify the input arguments:

  • --item: The item you want to review.
  • --openai-key: Your OpenAI API key.
  • --assistant-id: The ID of the OpenAI assistant you want to use.
  • --action (callable, optional): A custom action to perform on the OpenAI response.
  • --publisher (Publisher, optional): The publisher to use for the review.

Requirements

  • Python 3.6 or higher
  • OpenAI Python client
  • PyGithub

You can install the required Python packages using pip: pip install openai PyGithub

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

cururo-1.1.3.tar.gz (8.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

cururo-1.1.3-py3-none-any.whl (11.2 kB view details)

Uploaded Python 3

File details

Details for the file cururo-1.1.3.tar.gz.

File metadata

  • Download URL: cururo-1.1.3.tar.gz
  • Upload date:
  • Size: 8.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.9.19

File hashes

Hashes for cururo-1.1.3.tar.gz
Algorithm Hash digest
SHA256 0fd43baad07facf700157cc0f9d06b97008b2ab241695fabb66f4c297a1b60f1
MD5 29fcd0218fbb1ecef6bbb526c5129067
BLAKE2b-256 cc041e743b65b3a3913e2f842c5b7f93ac089d057c4a9098a05dd04841acb777

See more details on using hashes here.

File details

Details for the file cururo-1.1.3-py3-none-any.whl.

File metadata

  • Download URL: cururo-1.1.3-py3-none-any.whl
  • Upload date:
  • Size: 11.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.9.19

File hashes

Hashes for cururo-1.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 e7c7e2692512fea6e17e7e2bcb49f6dff424ef13dc9c0adf4bcf679f52df2cfb
MD5 ec3aa5f2566fe45a0b94f9b9e05398ea
BLAKE2b-256 425d638f0b38d795884f9e64d299d6c6da94374076dd25cbad6d1c40b8ffe2f8

See more details on using hashes here.

Supported by

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