Metadata-Version: 2.4
Name: repo-scaffold
Version: 0.13.2
Summary: shawn deng repo temple project
Author-email: shawndeng <shawndeng1109@qq.com>
License-Expression: MIT
Requires-Python: >=3.12
Requires-Dist: click>=8.1.8
Requires-Dist: cookiecutter>=2.6.0
Requires-Dist: ruff>=0.9.6
Provides-Extra: dev
Requires-Dist: commitizen>=3.12.0; extra == 'dev'
Requires-Dist: pytest-cov>=6.0.0; extra == 'dev'
Requires-Dist: pytest-mock>=3.14.0; extra == 'dev'
Requires-Dist: pytest>=8.3.4; extra == 'dev'
Requires-Dist: ruff>=0.9.7; extra == 'dev'
Provides-Extra: docs
Requires-Dist: mkdocs-gen-files>=0.5.0; extra == 'docs'
Requires-Dist: mkdocs-literate-nav>=0.6.1; extra == 'docs'
Requires-Dist: mkdocs-material>=9.5.3; extra == 'docs'
Requires-Dist: mkdocs>=1.5.3; extra == 'docs'
Requires-Dist: mkdocstrings-python>=1.7.5; extra == 'docs'
Requires-Dist: mkdocstrings>=0.24.0; extra == 'docs'
Requires-Dist: pymdown-extensions>=10.7; extra == 'docs'
Description-Content-Type: text/markdown

# repo-scaffold

[![PyPI version](https://badge.fury.io/py/repo-scaffold.svg)](https://badge.fury.io/py/repo-scaffold)
[![Python Version](https://img.shields.io/pypi/pyversions/repo-scaffold.svg)](https://pypi.org/project/repo-scaffold/)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/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

```bash
# Using uvx (recommended)
uvx install repo-scaffold

# Using pip
pip install repo-scaffold

# Using poetry
poetry add repo-scaffold
```

## Quick Start

```bash
# 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:

```bash
# 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]"
```
