Python-Template

Description of the project here.

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

---

Key features

• Built-in cursor native integration, with .cursorrules. Chat in CTRL+L or edit CTRL+K will automatically use .cursorrules to code in the native coding style of the repo / be a helpful guide to guide you in this repository
• Key feature 2
• Key feature 3

Requirements

• Rye

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

Quick Start

• make all - runs main.py
• make lint - runs black linter, an opinionated linter
• make test - runs all tests defined by TEST_TARGETS = tests/folder1 tests/folder2

Configuration Options

1. Global config: global_config/global_config.yaml

2. Test config: tests/config.yaml - these are configurations specific to the tests.

3. 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 open source packages:

• Cursor: The AI Code Editor
• Rye: a Hassle-Free Python Experience

Related

Coming soon...

You may also like...

Coming soon...

About the core contributors

• Eito Miyamura is a Co-Founder & CEO of GatlingX, formerly CS, AI, RL MSc at University of Oxford. Interested in ML/RL/Robotics/Zero Knowledge, Blockchain networks.