3.3 KiB
3.3 KiB
Mycopunk Swag - AI Assistant Context
Project Overview
This repository manages mycopunk merchandise (stickers, shirts, patches) with automated print-on-demand fulfillment. The workflow is CLI-driven, using open-source tools (Inkscape, GIMP, ImageMagick) for design work and API integrations with Printful and Prodigi for fulfillment.
Key Concepts
Design Structure
Each design lives in its own directory under designs/{category}/{slug}/:
{slug}.svg- Source vector filemetadata.yaml- Product configuration and metadataexports/- Generated output files (don't edit manually)
POD Providers
- Printful - Primary for apparel (t-shirts, hoodies)
- Prodigi - Primary for stickers and art prints
CLI Tool
Located in cli/, installed with pip install -e .
Main entry point: mycopunk command
File Locations
| What | Where |
|---|---|
| Design sources | designs/{stickers,shirts,misc}/ |
| Product templates | templates/{printful,prodigi}/ |
| CLI source | cli/mycopunk/ |
| Configuration | config/ |
| API credentials | config/.env (gitignored) |
Common Tasks
Creating a New Design
mycopunk design new stickers/design-name --template=sticker-3x3
# Then edit designs/stickers/design-name/design-name.svg in Inkscape
Exporting Designs
# Export single design
mycopunk design export stickers/design-name
# Batch export all stickers
mycopunk batch export --type=sticker
POD Operations
# Always test in sandbox first
mycopunk product create stickers/design-name --provider=prodigi --sandbox
# Push to production
mycopunk product push stickers/design-name --provider=prodigi
Design Requirements Quick Reference
| Product | Dimensions | Pixels @ 300 DPI |
|---|---|---|
| T-shirt front | 12" × 16" | 3600 × 4800 |
| Sticker 3×3" | 3" × 3" | 900 × 900 |
| Sticker 6×6" | 6" × 6" | 1800 × 1800 |
| Art print 8×10 | 8" × 10" | 2400 × 3000 |
Metadata.yaml Structure
name: "Design Name"
slug: design-name
description: "What this design represents"
tags: [mycelium, punk, nature]
created: 2025-01-24
author: jeff
source:
file: design-name.svg
format: svg
dimensions: { width: 4800, height: 4800 }
dpi: 300
color_profile: sRGB
products:
- type: sticker
provider: prodigi
sku: STICKER-VINYL-KISS-3X3
variants: [matte, gloss]
retail_price: 3.50
status: active # draft, active, retired
API Configuration
Credentials stored in config/.env (never commit):
PRINTFUL_API_TOKEN=xxx
PRODIGI_API_KEY_SANDBOX=xxx
PRODIGI_API_KEY_LIVE=xxx
Development Workflow
- Work on
devbranch for new features - Test CLI changes with
pip install -e . - Run
mycopunk design validatebefore committing - Push to Gitea, auto-mirrors to GitHub
- Merge to
mainwhen verified working
Important Notes
- Always validate designs before pushing to POD services
- Use
--sandboxflag when testing POD integrations - Exports are gitignored - regenerate with
mycopunk design export - Mockups require POD API access (not available offline)