Scaffold archipy domain
Skill SyntaxArc/archipy-plugin/skills/scaffold-archipy-domain
Scaffold a full ArchiPy domain slice (DTOs, errors, repository adapters, logic, service). Use when adding a new domain to an existing ArchiPy app.From its SKILL.md
npx -y skills add SyntaxArc/archipy-plugin --skill scaffold-archipy-domainAssembled from the repository path, not quoted from the project. Check it against their README if it does not work.
One thing to look at
- 2 stars2 stars. Stars are a popularity signal and not a quality one, but at this level it is likely that nobody has read this closely except its author, and you would be relying on your own review.
SKILL.md
3.6 KB, as published. Nobody here has run it
Scaffold ArchiPy Domain
Before writing files
Ask the user for:
- Domain name (e.g.
order) - ArchiPy extras to install/use (e.g.
redis,postgres,sqlalchemy,fastapi) - Transport: FastAPI (default) or gRPC
Compose — do not fork templates
Apply existing skills in order (reuse their constraints and file layouts):
- Models — stubs below, then flesh via
using-archipy-modelsrule - scaffold-archipy-adapter — thin wrapper under
repositories/<domain>/adapters/+<domain>_repository.py - scaffold-archipy-logic — at least one use-case under
logics/<domain>/ - scaffold-archipy-service —
services/<domain>/v1/<domain>_service.py
Install extras as needed: uv add "archipy[<extras>]".
Model stubs (create first)
models/
├── dtos/<domain>/
│ ├── domain/v1/
│ │ ├── <domain>_input_dto.py
│ │ └── <domain>_output_dto.py
│ └── repository/
│ └── <domain>_command_dto.py
├── errors/
│ └── <domain>_errors.py
└── entities/ # optional
└── <domain>_entity.py
Example shapes (order → rename):
# models/dtos/order/domain/v1/order_create_input_dto.py
from pydantic import BaseModel, Field
class OrderCreateInputDTO(BaseModel):
"""Domain input crossing the service → logic boundary."""
customer_id: str = Field(min_length=1)
sku: str = Field(min_length=1)
quantity: int = Field(gt=0)
# models/dtos/order/domain/v1/order_create_output_dto.py
from pydantic import BaseModel
class OrderCreateOutputDTO(BaseModel):
"""Domain output returned to the service layer."""
order_id: str
status: str
# models/dtos/order/repository/order_create_command_dto.py
from pydantic import BaseModel
class OrderCreateCommandDTO(BaseModel):
"""Repository write command — mapped from domain input inside the logic."""
customer_id: str
sku: str
quantity: int
# models/errors/order_errors.py
from archipy.models.errors import NotFoundError, InvalidArgumentError
class OrderNotFoundError(NotFoundError):
"""Raised when an order cannot be located."""
class OrderInvalidArgumentError(InvalidArgumentError):
"""Raised when order input fails domain validation."""
Naming: *InputDTO / *OutputDTO for domain; *CommandDTO / *QueryDTO for repository. Prefer ArchiPy BaseError
hierarchy — adjust base classes to what the installed archipy version exports.
Outcome checklist
- Domain + repository DTOs with ArchiPy naming (
*InputDTO,*CommandDTO, …) - Domain error subclassing ArchiPy
BaseErrorhierarchy -
repositories/<domain>/adapters/+ repository orchestrator - One logic with
@postgres_sqlalchemy_atomic_decoratorwhen Postgres SQLAlchemy is in play - One service v1 (FastAPI router or gRPC servicer)
- DI notes in
configs/containers.py: ports → adapters → repository → logic → service
Constraints
- Call flow:
services → logics → repositories → adapters → ArchiPy. - Cross-domain: logics may call other logics; never another domain’s repository.
- Double quotes, Google-style docstrings, Python 3.14+ typing.
- Do not invent a top-level app
adapters/package.
Docs
- https://syntaxarc.github.io/ArchiPy/getting-started/project_structure/
- https://syntaxarc.github.io/ArchiPy/getting-started/concepts/
- Bundled:
../archipy-docs/reference.md