Skip to content

Repository files navigation

<project_name>

Overview

Requirements

  • Python 3.11+
  • direnv (optional — auto-activates the venv in interactive shells)

Installation

python3 -m venv .venv
.venv/bin/python -m pip install -e .

For development (adds pytest):

.venv/bin/python -m pip install -e ".[dev]"

Configuration

Copy .env.example to .env and fill in the values. .env is gitignored — never commit it.

cp .env.example .env

Code reads configuration through src/<package_name>/config.py — see the get_env helper there; never call os.getenv elsewhere.

Usage

.venv/bin/<package_name>

Development

  • Run tests: .venv/bin/pytest
  • Logs are written to out/logs/app.log (rotating; not committed)
  • Agents and contributors: start with AGENTS.md
  • Agent session prompts: etc/PROMPT_0_KICKOFF.md (first session) or etc/PROMPT_0_FRONTIER.md (first session via a frontier model, which also writes the implementation tracks), then etc/PROMPT_RESUME.md for every session after
  • Example tracks: docs/example-tracks

Contact

Contact me: zach@azntaiji.com

About

Opinionated Python project template for AI-assisted development. Includes src layout, CLI entry point, dotenv config, rotating logs, and pytest scaffolding. Ships with a structured agent workflow (AGENTS.md, PLAN.md, STATE.md, track files) that guides AI coding agents through tasks with clear rules and checklists. Fork and customize.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages