|
1 |
| -# repo_scaffold |
| 1 | +# repo-scaffold |
2 | 2 |
|
3 |
| -### Overview |
| 3 | +[](https://badge.fury.io/py/repo-scaffold) |
| 4 | +[](https://pypi.org/project/repo-scaffold/) |
| 5 | +[](https://opensource.org/licenses/MIT) |
4 | 6 |
|
5 |
| -shawn deng repo temple project |
| 7 | +A modern project scaffolding tool that helps you quickly create standardized project structures with best practices. |
6 | 8 |
|
7 |
| -### Installation |
| 9 | +## Features |
| 10 | + |
| 11 | +- 🚀 Quick project initialization with modern best practices |
| 12 | +- 📦 Project templates with standardized structure |
| 13 | +- ⚙️ Interactive project configuration |
| 14 | +- 🔧 Pre-configured development tools (ruff, pytest, nox) |
| 15 | +- 📚 Documentation setup with MkDocs Material |
| 16 | +- 🔄 GitHub Actions workflows included |
| 17 | + |
| 18 | +## Installation |
| 19 | + |
| 20 | +```bash |
| 21 | +# Using uvx (recommended) |
| 22 | +uvx install repo-scaffold |
| 23 | + |
| 24 | +# Using pip |
| 25 | +pip install repo-scaffold |
| 26 | + |
| 27 | +# Using poetry |
| 28 | +poetry add repo-scaffold |
| 29 | +``` |
| 30 | + |
| 31 | +## Quick Start |
| 32 | + |
| 33 | +```bash |
| 34 | +# List available templates |
| 35 | +repo-scaffold list |
| 36 | + |
| 37 | +# Create a new project |
| 38 | +repo-scaffold create python |
| 39 | + |
| 40 | +# Create a project in a specific directory |
| 41 | +repo-scaffold create python -o ./my-projects |
| 42 | +``` |
| 43 | + |
| 44 | +## Available Templates |
| 45 | + |
| 46 | +Currently supported project templates: |
| 47 | + |
| 48 | +- **Python Project Template** |
| 49 | + - Modern Python project structure |
| 50 | + - Testing setup with pytest and nox |
| 51 | + - Documentation with MkDocs Material |
| 52 | + - Code quality with ruff |
| 53 | + - GitHub Actions CI/CD workflows |
| 54 | + - Dependency management with your choice of tool |
| 55 | + - Automated version management |
| 56 | + - MIT License template |
| 57 | + |
| 58 | +## Development Setup |
| 59 | + |
| 60 | +To set up the development environment: |
8 | 61 |
|
9 | 62 | ```bash
|
10 |
| -pip install repo_scaffold |
11 |
| -# or |
12 |
| -poetry add repo_scaffold |
| 63 | +# Clone the repository |
| 64 | +git clone https://github.com/ShawnDen-coder/repo-scaffold.git |
| 65 | +cd repo-scaffold |
| 66 | + |
| 67 | +# Create and activate virtual environment |
| 68 | +python -m venv .venv |
| 69 | +source .venv/bin/activate # On Windows: .venv\Scripts\activate |
| 70 | + |
| 71 | +# Install development dependencies |
| 72 | +pip install -e ".[dev,docs]" |
| 73 | +``` |
0 commit comments