82 lines
1.7 KiB
Markdown
82 lines
1.7 KiB
Markdown
# Mycopunk CLI
|
|
|
|
Command-line tool for managing mycopunk merchandise and print-on-demand fulfillment.
|
|
|
|
## Installation
|
|
|
|
```bash
|
|
# Install in development mode
|
|
pip install -e .
|
|
|
|
# Or install with dev dependencies
|
|
pip install -e ".[dev]"
|
|
```
|
|
|
|
## Quick Start
|
|
|
|
```bash
|
|
# Create a new sticker design
|
|
mycopunk design new stickers/my-design --template=sticker-3x3
|
|
|
|
# Export to print-ready PNG
|
|
mycopunk design export stickers/my-design
|
|
|
|
# Validate against POD requirements
|
|
mycopunk design validate stickers/my-design
|
|
|
|
# Create product on Prodigi (sandbox mode)
|
|
mycopunk product create stickers/my-design --provider=prodigi --sandbox
|
|
```
|
|
|
|
## Commands
|
|
|
|
See the full [CLI Reference](../docs/cli-reference.md) for all commands.
|
|
|
|
### Design Management
|
|
- `mycopunk design new` - Create design scaffold
|
|
- `mycopunk design list` - List all designs
|
|
- `mycopunk design export` - Export to print formats
|
|
- `mycopunk design validate` - Validate requirements
|
|
|
|
### POD Integration
|
|
- `mycopunk product create` - Create product on POD
|
|
- `mycopunk product push` - Push design updates
|
|
- `mycopunk product list` - List products
|
|
- `mycopunk mockup generate` - Generate mockups
|
|
|
|
### Batch Operations
|
|
- `mycopunk batch export` - Export all designs
|
|
- `mycopunk batch push` - Push all to POD
|
|
|
|
## Configuration
|
|
|
|
Copy `../config/.env.example` to `../config/.env` and add your API keys:
|
|
|
|
```bash
|
|
PRINTFUL_API_TOKEN=your_token
|
|
PRODIGI_API_KEY_SANDBOX=your_sandbox_key
|
|
PRODIGI_API_KEY_LIVE=your_live_key
|
|
```
|
|
|
|
## Development
|
|
|
|
```bash
|
|
# Run tests
|
|
pytest
|
|
|
|
# Format code
|
|
black mycopunk/
|
|
|
|
# Lint
|
|
ruff check mycopunk/
|
|
|
|
# Type check
|
|
mypy mycopunk/
|
|
```
|
|
|
|
## Requirements
|
|
|
|
- Python 3.10+
|
|
- Inkscape (for SVG export)
|
|
- ImageMagick (optional, for local mockups)
|