Python-Template

Description of the project here.

Key Features • Requirements • Quick Start • Configuration • Credits • About the Core Contributors

---

Key Features

• Super opinionated python stack to enable super fast development on new projects without getting the usual tooling available
• CI/Linters built-in
• LLM Inference/Observability built-in
• (Optional) saas branch contains default template for building SaaS apps

Requirements

• uv

  curl -LsSf https://astral.sh/uv/install.sh | sh
  

Quick Start

• make all - runs main.py
• make fmt - runs black linter, an opinionated linter
• make banner - create a new banner that makes the README nice 😊
• make test - runs all tests defined by TEST_TARGETS = tests/folder1 tests/folder2

Configuration Options

This project uses pydantic-settings for configuration management, providing automatic validation and type checking.

Configuration Files:

• common/global_config.yaml - Base configuration values
• common/config_models.py - Pydantic models for validation
• common/global_config.py - Main Config class
• .env - Environment variables and secrets (create this file)

1. Global config: common/global_config.yaml - Add hyperparameters here

2. Environment Variables: Store environment variables in .env (git-ignored) and common/global_config.py will read them automatically with validation:

   .env file:

   OPENAI_API_KEY=sk-...

   python file:

   from common import global_config
   
   print(global_config.OPENAI_API_KEY)

Credits

This software uses the following tools:

• Cursor: The AI Code Editor
• uv
• DSPY: Pytorch for LLM Inference
• LangFuse: LLM Observability Tool

About the Core Contributors

Made with contrib.rocks.