author | Ollivier Robert <roberto@keltia.net> |
Mon, 10 Apr 2017 21:38:40 +0200 | |
changeset 52 | 825b890aff85 |
parent 32 | c28f7e417146 |
child 62 | 4b861c82e5f6 |
permissions | -rw-r--r-- |
0 | 1 |
# gondole |
2 | 2 |
|
0 | 3 |
Go version of the Mastodon API |
2 | 4 |
|
5 |
[![godoc](https://img.shields.io/badge/godoc-reference-blue.svg?style=flat)](https://godoc.org/github.com/keltia/gondole) [![license](https://img.shields.io/badge/license-MIT-red.svg?style=flat)](https://raw.githubusercontent.com/keltia/gondole/master/LICENSE) [![build](https://img.shields.io/travis/keltia/gondole.svg?style=flat)](https://travis-ci.org/keltia/gondole) [![Go Report Card](https://goreportcard.com/badge/github.com/keltia/gondole)](https://goreportcard.com/report/github.com/keltia/gondole) |
|
6 |
||
7 |
`gondole` is a [Go](https://golang.org/) library to access the Mastondon [REST API](http://www.rubydoc.info/gems/mastodon-api/Mastodon/REST/API). |
|
8 |
||
9 |
**Work in progress, still incomplete** |
|
10 |
||
11 |
## Installation |
|
12 |
||
13 |
Like many Go-based tools, installation is very easy |
|
14 |
||
15 |
go get github.com/keltia/gondole |
|
16 |
||
17 |
or |
|
18 |
||
19 |
git clone https://github.com/keltia/gondole |
|
20 |
go install ./cmd/... |
|
21 |
||
52 | 22 |
The library is fetched, compiled and installed in whichever directory is specified by `$GOPATH`. The `gondole-cli` binary will also be installed. |
3 | 23 |
|
32
c28f7e417146
Point to configuration files.
Ollivier Robert <roberto@keltia.net>
parents:
11
diff
changeset
|
24 |
## Configuration |
c28f7e417146
Point to configuration files.
Ollivier Robert <roberto@keltia.net>
parents:
11
diff
changeset
|
25 |
|
c28f7e417146
Point to configuration files.
Ollivier Robert <roberto@keltia.net>
parents:
11
diff
changeset
|
26 |
The configuration is stored in the standard place: `$HOME/.config/gondole`. You can find a global configuration file named `config.toml`and a file for each instance you have connected with, named `<instance>.toml`. |
c28f7e417146
Point to configuration files.
Ollivier Robert <roberto@keltia.net>
parents:
11
diff
changeset
|
27 |
|
c28f7e417146
Point to configuration files.
Ollivier Robert <roberto@keltia.net>
parents:
11
diff
changeset
|
28 |
When you connect `gondole` to a given instance you have never connected before, it will register the application, get the token and save it. |
c28f7e417146
Point to configuration files.
Ollivier Robert <roberto@keltia.net>
parents:
11
diff
changeset
|
29 |
|
3 | 30 |
## Name |
31 |
||
32 |
Trying to define a name close to *Mastodon*, one could come up with *godon* and in French, *gondole* (the small boats in Venice) is easy to take. |
|
33 |
||
6 | 34 |
## References |
35 |
||
11
39a5ce85e9de
Add link to main API description.
Ollivier Robert <roberto@keltia.net>
parents:
6
diff
changeset
|
36 |
- [Mastodon API doc](https://github.com/tootsuite/mastodon/blob/master/docs/Using-the-API/API.md) |
6 | 37 |
- [Mastodon Ruby API](http://www.rubydoc.info/gems/mastodon-api/Mastodon/REST/API) |
38 |
- [Mastodon Python](https://mastodonpy.readthedocs.io/en/latest/) |
|
39 |
- [Mastodon repo](https://github.com/tootsuite/mastodon) |