Documentation
¶
Overview ¶
Package mygene is the library behind the mygene command line: the HTTP client, request shaping, and the typed data models for MyGene.info.
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 API throws under load. Build your endpoint calls and JSON decoding on top of it.
Index ¶
- Constants
- type Client
- func (c *Client) Get(ctx context.Context, rawURL string) ([]byte, error)
- func (c *Client) GetGene(ctx context.Context, geneID string) (*Gene, error)
- func (c *Client) Post(ctx context.Context, rawURL string, payload any) ([]byte, error)
- func (c *Client) SearchGenes(ctx context.Context, query string, limit int, species string) ([]*Gene, int, error)
- type Domain
- type Gene
Constants ¶
const BaseURL = "https://" + Host + "/v3"
BaseURL is the root every request is built from.
const DefaultUserAgent = "mygene/dev (+https://github.com/tamnd/mygene-cli)"
DefaultUserAgent identifies the client to MyGene.info. A real, honest User-Agent is both polite and the thing most likely to keep you unblocked.
const Host = "mygene.info"
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 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 MyGene.info over HTTP.
func NewClient ¶
func NewClient() *Client
NewClient returns a Client with sensible defaults: a 30s timeout, a 300ms minimum gap between requests, and three 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 mygene 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). Any non-empty string is accepted as a gene ID.
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 Gene ¶
type Gene struct {
ID string `json:"id" kit:"id"`
Symbol string `json:"symbol"`
Name string `json:"name,omitempty"`
TaxID int `json:"tax_id,omitempty"`
EntrezGene string `json:"entrezgene,omitempty"`
EnsemblGene string `json:"ensembl_gene,omitempty"`
GeneType string `json:"gene_type,omitempty"`
Chromosome string `json:"chromosome,omitempty"`
Start int `json:"start,omitempty"`
End int `json:"end,omitempty"`
}
Gene is the public record type: one gene from MyGene.info.
Source Files