README.md

Python-Template

Description of the project here.

Key Features • Requirements • Quick Start • Configuration • Credits Related 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

• Rye

  curl -sSf https://rye.astral.sh/get | bash
  

• prek

  curl --proto '=https' --tlsv1.2 -LsSf https://github.com/j178/prek/releases/download/v0.3.3/prek-installer.sh | sh
  

Quick Start

• make all - runs main.py
• make fmt - runs black linter, an opinionated linter
• make lint - runs prek hooks (linting, formatting, checks)
• 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

1. Global config: global_config/global_config.yaml

2. Environment Variables: Store environmnent variables in .env (Create this if not exists) and global_config/global_config.py will read those out automatically. Then, you can import them as follows:

   .env file:

   OPENAI_API_KEY=sk-...

   python file:

   from global_config import global_config
   
   print(global_config.OPENAI_API_KEY)

Credits

This software uses the following tools:

• Cursor: The AI Code Editor
• Rye: a Hassle-Free Python Experience
• prek: Better pre-commit, re-engineered in Rust
• DSPY: Pytorch for LLM Inference
• LangFuse: LLM Observability Tool

Related

Coming soon...

You may also like...

Coming soon...