Agentic RAG Boilerplate
A powerful boilerplate for creating Retrieval-Augmented Generation (RAG) applications with agentic capabilities. This template provides a solid foundation for building AI-powered applications that can retrieve and process information intelligently.
Features
- 🚀 FastAPI-based REST API
- 🤖 LangChain integration for RAG capabilities
- 🔍 Efficient document processing and retrieval
- 🔐 Environment-based configuration
- 📦 Well-structured project layout
- 🛠️ Easy to extend and customize
Quick Start
Installation
pip install create-agentic-rag
Create a New Project
create-agentic-rag my-project-name
This will create a new directory with your project name and set up the basic structure.
Setup Your Project
- Navigate to your project directory:
cd my-project-name
- Create and activate a virtual environment:
python -m venv venv
source venv/bin/activate # On Windows: venv\Scripts\activate
- Install dependencies:
pip install -r requirements.txt
- Configure your environment:
cp .env.example .env
Edit the .env file with your configuration settings.
Running the Application
Start the FastAPI server:
uvicorn app.main:app --reload
The API will be available at http://localhost:8000
Project Structure
.
├── app/
│ ├── api/ # API routes and endpoints
│ ├── core/ # Core application logic
│ ├── models/ # Data models
│ ├── services/ # Business logic and services
│ └── main.py # Application entry point
├── .env.example # Example environment variables
├── requirements.txt # Project dependencies
└── README.md # This file
API Documentation
Once the server is running, you can access the interactive API documentation at:
- Swagger UI:
http://localhost:8000/docs - ReDoc:
http://localhost:8000/redoc
Environment Variables
The following environment variables are required:
OPENAI_API_KEY: Your OpenAI API keyLANGCHAIN_API_KEY: Your LangChain API keyLANGCHAIN_PROJECT: Your LangChain project nameLANGCHAIN_TRACING_V2: Enable/disable LangChain tracingLANGCHAIN_ENDPOINT: LangChain API endpoint
Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
License
This project is licensed under the MIT License - see the LICENSE file for details.
Support
If you encounter any issues or have questions, please open an issue in the repository.
Metadata
Release files for create-agentic-rag 0.1.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| create_agentic_rag-0.1.2.tar.gz | 13.6 kB | Without provenance | Details for create_agentic_rag-0.1.2.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| create_agentic_rag-0.1.2-py3-none-any.whl | Python 3 | none | any | Details for create_agentic_rag-0.1.2-py3-none-any.whl |
Total release size: 32.2 kB
Release files / create_agentic_rag-0.1.2.tar.gz
| Download URL | create_agentic_rag-0.1.2.tar.gz |
|---|---|
| Size | 13.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
a4fcb3e5cf0c281556d148fc558c694f4fea5d8d5a127a9510c15613c7fcb03a
|
|
BLAKE2b-256 checksum How to use checksums |
3a3160371c223e9c47dd194fe0c660460c66231fc6240062c2f01065e139c7a7
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.11.11
|
Release files / create_agentic_rag-0.1.2-py3-none-any.whl
| Download URL | create_agentic_rag-0.1.2-py3-none-any.whl |
|---|---|
| Size | 18.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
9989142a0850dd8a33d60efc120942d1f057845b594b654192293e02bec12dee
|
|
BLAKE2b-256 checksum How to use checksums |
0b8ffa4e9f564b05928ad0c303a441c4c3e5ba9e0929b0df04ad8d046a7ba93d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.11.11
|
Security for create-agentic-rag 0.1.2
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.