Categorygithub.com/jedbeom/madon
modulepackage
1.6.0
Repository: https://github.com/jedbeom/madon.git
Documentation: pkg.go.dev
Overview
Versions
1
Dependencies
18
Dependents
0
Files
1.6k SLOC

# README

madon

Golang library for the Mastodon API

godoc license build Go Report Card

madon is a Go library to access the Mastondon REST API.

This implementation covers 100% of the current API, including the streaming API.

The madonctl console client uses this library exhaustively.

Installation

To install the library (Go >= v1.5 required):

go get github.com/McKael/madon

You can test it with my CLI tool:

go get github.com/McKael/madonctl

Usage

This section has not been written yet (PR welcome).

For now please check godoc and check the madonctl project implementation.

History

This API implementation was initially submitted as a PR for gondole.

The repository is actually a fork of my gondole branch so that history and credits are preserved.

References

# Functions

NewApp registers a new application with a given instance.
RestoreApp recreates an application client with existing secrets.

# Constants

MadonVersion contains the version of the Madon library.
NoRedirect is the URI for no redirection in the App registration.

# Variables

Error codes.
Error codes.
Error codes.
Error codes.
Error codes.

# Structs

Account represents a Mastodon account entity.
Application represents a Mastodon application entity.
Attachment represents a Mastodon attachement entity.
Card represents a Mastodon card entity.
Client contains data for a madon client application.
Context represents a Mastodon context entity.
Error represents a Mastodon error entity.
Instance represents a Mastodon instance entity.
LimitParams contains common limit/paging options for the Mastodon REST API.
Mention represents a Mastodon mention entity.
Notification represents a Mastodon notification entity.
Relationship represents a Mastodon relationship entity.
Report represents a Mastodon report entity.
Results represents a Mastodon results entity.
Status represents a Mastodon status entity.
StreamEvent contains a single event from the streaming API.
Tag represents a Mastodon tag entity.
UserToken represents a user token as returned by the Mastodon API.

# Type aliases

DomainName is a domain name string, as returned by the domain_blocks API.