A modern project scaffolding tool that helps you quickly create standardized project structures with best practices.
- 🚀 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
# Using uvx (recommended) uvx install repo-scaffold # Using pip pip install repo-scaffold # Using poetry poetry add repo-scaffold# 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-projectsCurrently 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
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]"