Skip to content

Azeem-2/Boiler-Plate-code

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

🤖 OpenAI Agent Boilerplate

Quickstart guide to run a basic agent using OpenAI Agents SDK with uv and environment variables!


📦 Features

  • 🤖 Basic agent boilerplate using OpenAI Agents SDK
  • 🐍 Python-based project
  • ⚡ Easy virtual environment setup with uv
  • 🔒 Supports environment variables via .env
  • 🏁 Simple run command for quick start

🛠️ Setup Instructions

1️⃣ Add Your Environment Variables

Create a .env file in the project directory and add your secrets/configuration:

GEMINI_API_KEY=your_api_key_here

2️⃣ Create a Virtual Environment

Open a terminal in the project directory and run:

uv venv

3️⃣ Run the Agent

Start your agent with:

uv run main.py

📁 Project Structure

main.py          # Entry point for the agent
pyproject.toml   # Project configuration
README.md        # Project documentation
uv.lock          # uv dependency lock file
.env             # Environment variables

🙋‍♂️ Need Help?

Feel free to open an issue or reach out for support!


ℹ️ About This Project

This is a boilerplate for running a basic agent using the OpenAI Agents SDK. It is not a simple Python script, but a foundation for building agent-based applications.

Requirements:

  • Python
  • uv (for environment management)
  • OpenAI Agents SDK


Happy Coding! 🎉

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages