Skip to content

Edison-Watch/Python-Template

 
 

Repository files navigation

Python-Template

2

Description of the project here.

Key FeaturesRequirementsQuick StartConfigurationCredits Related About the Core Contributors

Dynamic TOML Badge Project Version Python Version License Dynamic YAML Badge GitHub repo size GitHub Actions Workflow Status


2

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
    

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

  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:

Related

Coming soon...

You may also like...

Coming soon...

About

🐍 Rye Python template with CI + Global Config + Cursor Support

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages

  • Python 86.0%
  • Makefile 14.0%