From 928ef0a37174dd0634b4b89e5df9646cd47ce86a Mon Sep 17 00:00:00 2001 From: "codegen-sh[bot]" <131295404+codegen-sh[bot]@users.noreply.github.com> Date: Fri, 30 May 2025 22:16:31 +0000 Subject: [PATCH 1/2] docs: add Quick Start section to README for better onboarding - Added concise 3-step Quick Start guide - Reorganized existing example under 'Example Usage' section - Improves new user experience with clear getting started steps --- README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/README.md b/README.md index 2e711f17b..4b47465c2 100644 --- a/README.md +++ b/README.md @@ -24,6 +24,25 @@ The Codegen SDK provides a programmatic interface to code agents provided by [Codegen](https://codegen.com). +## Quick Start + +1. **Install the SDK**: + ```bash + pip install codegen + ``` + +2. **Get your API credentials** at [codegen.com/developer](https://codegen.com/developer) + +3. **Run your first agent**: + ```python + from codegen.agents.agent import Agent + + agent = Agent(org_id="YOUR_ORG_ID", token="YOUR_API_TOKEN") + task = agent.run(prompt="Add a hello world function to my codebase") + ``` + +## Example Usage + ```python from codegen.agents.agent import Agent From 91fd0919fe52c1443cf41936d25e0cca86e727f0 Mon Sep 17 00:00:00 2001 From: "codegen-sh[bot]" <131295404+codegen-sh[bot]@users.noreply.github.com> Date: Fri, 30 May 2025 22:17:32 +0000 Subject: [PATCH 2/2] Automated pre-commit update --- README.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 4b47465c2..31412a00e 100644 --- a/README.md +++ b/README.md @@ -27,16 +27,18 @@ The Codegen SDK provides a programmatic interface to code agents provided by [Co ## Quick Start 1. **Install the SDK**: + ```bash pip install codegen ``` -2. **Get your API credentials** at [codegen.com/developer](https://codegen.com/developer) +1. **Get your API credentials** at [codegen.com/developer](https://codegen.com/developer) + +1. **Run your first agent**: -3. **Run your first agent**: ```python from codegen.agents.agent import Agent - + agent = Agent(org_id="YOUR_ORG_ID", token="YOUR_API_TOKEN") task = agent.run(prompt="Add a hello world function to my codebase") ```