ketozhang/asdf-pydantic

A better tutorial on writing your first asdf-pydantic model

Open

#70 opened on Sep 7, 2025

View on GitHubContributor guide
 (0 comments) (0 reactions) (1 assignee)Python (0 forks)auto 404
documentationgood first issue

Repository metrics

Stars
 (2 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

Th tutorial Writing ASDF Pydantic models to define tagged objects tutorial is pretty barebones.

Currently, the best first time tutorial is in the usage docs in the the home page

The docs can benefit from a better end-to-end tutorial from writing your first model to packaging it up into an extension, schemas, manifest, etc and even PyPI upload.

Contributor guide

Research direction
Create a step by step tutorial covering writing an asdf pydantic model, creating an extension, defining schemas and manifest, and optionally uploading to PyPI. Use the existing usage docs as a starting point and expand with details.
Tech stack
python
Domain
documentationbackend
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
PythonPydantic
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85