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.2.tar.gz (8.6 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.2-py3-none-any.whl (11.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: cururo-1.1.2.tar.gz
  • Upload date:
  • Size: 8.6 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.2.tar.gz
Algorithm Hash digest
SHA256 3bd17b2392458aeac3daf4eb2856fa3c48e839f2979cf428eab93d7f6aead83e
MD5 015029ec8d1603acfd9c783fef992cd3
BLAKE2b-256 f8f06fd602405dc16b17f69da446a51f626e3e86527d9c9b5e62dd4805a78973

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cururo-1.1.2-py3-none-any.whl
  • Upload date:
  • Size: 11.7 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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 7d1ec242a7a1c2831173ac949eb3056047edd9bfe81194a9e52d9206025e380d
MD5 a2541ce6c50697da3908ac7993aa4dce
BLAKE2b-256 27b800ec64c593a07e70446fbd0744f569237d497149c440f59a8f75d7f5485a

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