Skip to main content

shawn deng repo temple project

Project description

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]"

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

repo_scaffold-0.13.2.tar.gz (50.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

repo_scaffold-0.13.2-py3-none-any.whl (26.1 kB view details)

Uploaded Python 3

File details

Details for the file repo_scaffold-0.13.2.tar.gz.

File metadata

  • Download URL: repo_scaffold-0.13.2.tar.gz
  • Upload date:
  • Size: 50.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.8.3

File hashes

Hashes for repo_scaffold-0.13.2.tar.gz
Algorithm Hash digest
SHA256 a1573c66001c3371e23058fa583db91a4b182278b41da51952a6f7a3e430655d
MD5 b4fd8bc0773947df370e70cd7c636b37
BLAKE2b-256 b512674c08dafda06fc18f89eb7e9795938d6bd3011ea9041d77831ef52c64a7

See more details on using hashes here.

File details

Details for the file repo_scaffold-0.13.2-py3-none-any.whl.

File metadata

File hashes

Hashes for repo_scaffold-0.13.2-py3-none-any.whl
Algorithm Hash digest
SHA256 9ad652c5cb82226d12011e458648c4878ab5f778b75357886b8e6b013e993525
MD5 115af819994f990ec05275eb5e3eefb1
BLAKE2b-256 a07c3184042176010866e55f78824008cd89f65b4657c3309a325b06e82d4e9a

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page