Skip to content

ShawnDen-coder/repo-scaffold

Repository files navigation

repo-scaffold

PyPI version Python Version License: MIT

A modern project scaffolding tool that helps you quickly create standardized project structures with best practices.

Features

  • 🚀 Quick project initialization with modern best practices
  • 📦 Project templates with standardized structure
  • ⚙️ Interactive project configuration
  • 🔧 Pre-configured development tools (ruff, pytest, nox)
  • 📚 Documentation setup with MkDocs Material
  • 🔄 GitHub Actions workflows included

Installation

# Using uvx (recommended) uvx install repo-scaffold # Using pip pip install repo-scaffold # Using poetry poetry add repo-scaffold

Quick Start

# List available templates repo-scaffold list # Create a new project repo-scaffold create python # Create a project in a specific directory repo-scaffold create python -o ./my-projects

Available Templates

Currently supported project templates:

  • Python Project Template
    • Modern Python project structure
    • Testing setup with pytest and nox
    • Documentation with MkDocs Material
    • Code quality with ruff
    • GitHub Actions CI/CD workflows
    • Dependency management with your choice of tool
    • Automated version management
    • MIT License template

Development Setup

To set up the development environment:

# Clone the repository git clone https://github.com/ShawnDen-coder/repo-scaffold.git cd repo-scaffold # Create and activate virtual environment python -m venv .venv source .venv/bin/activate # On Windows: .venv\Scripts\activate # Install development dependencies pip install -e ".[dev,docs]"

About

shawndeng's package template project

Resources

Stars

Watchers

Forks

Packages

 
 
 

Contributors