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.0.0.tar.gz (8.3 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.0.0-py3-none-any.whl (10.9 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for cururo-1.0.0.tar.gz
Algorithm Hash digest
SHA256 97750978a9cdb26d9df6b7940564d786e1ee287f0c603b9db1108af000a60757
MD5 7daf531e54cf7d7023c31267d05825e6
BLAKE2b-256 41dddf54a85e892c0bc95cf1b690c37fe1632fe5dda98da0d24fffbbf3aeb1b8

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for cururo-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 42364edb1180f9c882a4df4afdb1a68e91b151b419c9838a96b7985454844990
MD5 b95c273f8ae6b99688ce6f8a356236c7
BLAKE2b-256 6308e47ec457e14375765a6488df8b073c42adef211c0cef49bcbb7f3d1334d1

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