whiteduck

Add your description here

0.5.0
PyPI

Maintainers: 1

white duck Project Starter

A command-line tool for quickly creating new projects from templates. Automatically discovers and provides commands for all templates in the templates directory.

Installation

# Clone the repository
git clone https://github.com/whiteduck-dev/project-starter.git
cd project-starter

# Install using uv
uv build
uv pip install -e .

Usage

Install uv

Visit the official documentation for detailed installation instructions:

List available templates:

uvx whiteduck --help

Create a new project:

# Basic usage - creates in current directory
uvx whiteduck react

# Specify output directory
uvx whiteduck react -o my-project

Get help for a specific template:

uvx whiteduck react --help

Available Templates

react - A modern React project template with:
- TypeScript support
- Vite for fast development
- TailwindCSS for styling
- Shadcn/ui components
- Python backend structure
lib - A template for creating Python libraries
- Modern Python package structure
- Testing setup
- Documentation scaffolding
package - A template for Python packages
- Basic package structure
- Development tools configuration
- Distribution setup

Adding New Templates

Create a new directory under src/whiteduck/templates/
Name the directory what you want the command to be (e.g., api for whiteduck api)
Add your template files to this directory
The command will be automatically available - no code changes needed

For example:

# Create a new template
mkdir src/whiteduck/templates/api

# Add template files
cp -r my-api-files/* src/whiteduck/templates/api/

# The command is now available
uv run whiteduck api --help

License

FAQs

What is whiteduck?

Is whiteduck well maintained?

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install