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 Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

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

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: cururo-1.1.0-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.0-py3-none-any.whl
Algorithm Hash digest
SHA256 eb487e1bbb2c9fedf7044a5510ef468b1d3a67e3a637e989f426da8a12bbd251
MD5 eba9d4d356a5878154579a3763545a7f
BLAKE2b-256 f1e6ea13d692160c3e8976eaa502a0987c4db498608fec7db44bf76bd626d8b7

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