Documentation
¶
Overview ¶
Package echr is the library behind the echr command line: the HTTP client, request shaping, and the typed data models for the ECHR HUDOC database of 229k+ case judgments and decisions.
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://hudoc.echr.coe.int/app/query/results"
BaseURL is the root every request is built from.
const DefaultUserAgent = "echr-cli/0.1.0"
DefaultUserAgent identifies the client to HUDOC. A real, honest User-Agent is both polite and the thing most likely to keep you unblocked.
const Host = "hudoc.echr.coe.int"
Host is the site this client talks to, and the host the URI driver in domain.go claims.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Case ¶
type Case struct {
ID string `json:"id" kit:"id"` // itemid
DocName string `json:"doc_name"`
JudgmentDate string `json:"judgment_date"`
DecisionDate string `json:"decision_date"`
AppNo string `json:"app_no"`
Respondent string `json:"respondent"`
Importance string `json:"importance"`
Type string `json:"type"`
Collection string `json:"collection"`
}
Case is the public record type: one ECHR case from HUDOC.
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 HUDOC over HTTP.
func NewClient ¶
func NewClient() *Client
NewClient returns a Client with sensible defaults: a 30s timeout, a 500ms minimum gap between requests, and three retries on transient errors.
func (*Client) RecentCases ¶
RecentCases lists recently decided cases sorted by judgment date descending.
type Domain ¶
type Domain struct{}
Domain is the echr driver. It carries no state; the per-run client is built by the factory Register hands kit.
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.