Documentation
¶
Overview ¶
Package kitsu is the library behind the kitsu command line: the HTTP client, request shaping, and the typed data models for kitsu.io.
The Client here is the spine every command shares. It sets a real User-Agent, paces requests so a busy session stays polite, and retries the transient failures (429 and 5xx) that any public site throws under load. Build your endpoint calls and JSON decoding on top of it.
Index ¶
Constants ¶
const BaseURL = "https://" + Host + "/api/edge"
BaseURL is the root every request is built from.
const DefaultUserAgent = "kitsu-cli/dev (+https://github.com/tamnd/kitsu-cli)"
DefaultUserAgent identifies the client to kitsu. A real, honest User-Agent is both polite and the thing most likely to keep you unblocked.
const Host = "kitsu.io"
Host is the site this client talks to.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Anime ¶
type Anime struct {
ID string `kit:"id" json:"id"`
Title string `json:"title"`
Synopsis string `json:"synopsis"`
Rating string `json:"rating"`
EpisodeCount int `json:"episode_count"`
Status string `json:"status"`
StartDate string `json:"start_date"`
EndDate string `json:"end_date"`
Poster string `json:"poster"`
}
Anime is a single anime record from kitsu.io/api/edge/anime.
type Category ¶
type Category struct {
ID string `kit:"id" json:"id"`
Title string `json:"title"`
MediaCount int `json:"media_count"`
}
Category is a single category from kitsu.io/api/edge/categories.
type Client ¶
type Client struct {
HTTP *http.Client
UserAgent string
// Rate is the minimum gap between requests. Zero means no pacing.
Rate time.Duration
Retries int
// contains filtered or unexported fields
}
Client talks to kitsu.io over HTTP.
func NewClient ¶
func NewClient() *Client
NewClient returns a Client with sensible defaults: a 30s timeout, a 200ms minimum gap between requests, and five retries on transient errors.
func (*Client) Get ¶
Get fetches url and returns the response body. It paces and retries according to the client's settings. The caller owns nothing extra; the body is read fully and closed here.
type Domain ¶
type Domain struct{}
Domain is the kitsu driver. It carries no state; the per-run client is built by the factory Register hands kit.
func (Domain) Classify ¶
Classify turns any accepted input into the canonical (type, id). Numeric string -> "anime"; "m:" prefix + digits -> "manga"; otherwise "anime".
func (Domain) Info ¶
func (Domain) Info() kit.DomainInfo
Info describes the scheme, the hostnames a pasted link is matched against, and the identity reused for the binary's help and version.
type Manga ¶
type Manga struct {
ID string `kit:"id" json:"id"`
Title string `json:"title"`
Synopsis string `json:"synopsis"`
Rating string `json:"rating"`
ChapterCount int `json:"chapter_count"`
VolumeCount int `json:"volume_count"`
Status string `json:"status"`
StartDate string `json:"start_date"`
EndDate string `json:"end_date"`
}
Manga is a single manga record from kitsu.io/api/edge/manga.
Source Files