Skip to content

INDEX.md

Latest commit

 

History

History
116 lines (91 loc) · 4.29 KB

INDEX.md

File metadata and controls

116 lines (91 loc) · 4.29 KB

Documentation Index

Welcome to the Trobz Python Template documentation. This index helps you find the information you need.

Quick Navigation

Getting Started

New to the template? Start here:

  1. README.md - Project overview, features, and quick start

For Developers

Building with the template:

  1. code-standards.md - Code quality standards and conventions
  2. codebase-summary.md - Project structure reference

Document Overview

README.md (Main Entry Point)

Purpose: Project introduction and feature overview Length: 344 lines Audience: Everyone Key Sections:

  • Features overview
  • Quick start guide
  • Project type details (CLI, FastAPI, Flask)
  • Configuration guide
  • Development workflow
  • GitHub Actions integration
  • Support and resources

docs/codebase-summary.md

Purpose: Codebase structure and organization reference Length: 288 lines Audience: Developers, architects Key Sections:

  • Directory structure
  • Key components
  • Template variables
  • Conditional rendering
  • Generated project structure
  • Build system overview

docs/code-standards.md

Purpose: Coding conventions and quality standards Length: 532 lines Audience: Developers Key Sections:

  • Project structure and organization
  • File naming conventions
  • Python standards (PEP 8)
  • Linting rules (Ruff)
  • Import organization
  • Type hints and docstrings
  • Testing requirements (80%+ coverage)
  • Git workflow (conventional commits)
  • Pre-commit hooks
  • Error handling patterns
  • Security standards

By Topic

Template Usage

CLI Applications

Web Services

Code Quality

Development Workflow

Common Tasks

I want to create a new CLI project

  1. Read README.md - Quick Start
  2. Follow deployment-guide.md - Using the Template
  3. Refer to README.md - CLI Application for examples
  4. Check deployment-guide.md - CLI Development

I want to create a new web service

  1. Read README.md - Quick Start
  2. Follow deployment-guide.md - Using the Template
  3. Choose framework: README.md - FastAPI Service or Flask Service
  4. Check deployment-guide.md - Service Development

I need to deploy a generated project

  1. Read deployment-guide.md - Service Deployment
  2. Choose deployment method (Gunicorn, Docker, Systemd, Heroku, AWS, etc.)
  3. Configure environment: deployment-guide.md - Configuration
  4. Set up CI/CD: deployment-guide.md - GitHub Actions

I need to understand code standards

  1. Read code-standards.md
  2. Check specific sections: naming conventions, linting, testing
  3. Review git workflow and conventional commits

I'm having issues with the template

  1. Check deployment-guide.md - Troubleshooting
  2. Look for your issue in the common problems section
  3. Read README.md - Support for additional help