alazyreader/go-discogs
Archived
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Doc fixed

Browse Source
This commit is contained in:
irlndts 2018-01-22 21:01:29 +03:00
parent 795cdb9f79
commit 87747a846f
2 changed files with 16 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
README.md
View File

@ -23,44 +23,36 @@ The discogs package provides a client for accessing the Discogs API.
First of all import library and init client variable. According to discogs api documentation you [must provide your user-agent](https://www.discogs.com/developers/#page:home,header:home-general-information). First of all import library and init client variable. According to discogs api documentation you [must provide your user-agent](https://www.discogs.com/developers/#page:home,header:home-general-information).
```go ```go
import "github.com/irlndts/go-discogs" import "github.com/irlndts/go-discogs"
...
client := discogs.NewClient()
``` ```
```go ```go
client := discogs.NewClient("TestDiscogsClient/0.0.1 +example.com", "") client.UserAgent("TestDiscogsClient/0.0.1 +example.com")
``` ```
Some requests require authentification (as any user). According to [Discogs](https://www.discogs.com/developers/#page:authentication,header:authentication-discogs-auth-flow), to send requests with Discogs Auth, you have two options: sending your credentials in the query string with key and secret parameters or a token parameter. Some requests require authentification (as any user). According to [Discogs](https://www.discogs.com/developers/#page:authentication,header:authentication-discogs-auth-flow), to send requests with Discogs Auth, you have two options: sending your credentials in the query string with key and secret parameters or a [token parameter](https://www.discogs.com/settings/developers).
This is token way example: This is token way example:
```go ```go
client := discogs.NewClient("TestDiscogsClient/0.0.1 +example.com", "sometoken") client.Token("sometoken")
``` ```
Don't forget to set required currency ("USD", "GBP", "EUR", "CAD", "AUD", "JPY", "CHF", "MXN", "BRL", "NZD", "SEK", "ZAR" are allowed):
```go
err := client.Currency("EUR");
```
#### Releases #### Releases
```go ```go
release, err := client..Release(9893847) release, err := client.Release(9893847)
fmt.Println(release.Artists[0].Name, " - ", release.Title)
fmt.Println(release.Artists[0].Name, " - ", release.Title) // St. Petersburg Ska-Jazz Review - Elephant Riddim // St. Petersburg Ska-Jazz Review - Elephant Riddim
```
#### Artists
```go
params := &discogs.LabelParams{Label_id: "890477", Page: 2, Per_page: 3}
label, _, err := client.Label.Releases(params)
for _, release := range label.Releases {
fmt.Println(release.Title)
}
/*
Someday / I Hate Everything About You
Spy Potion
Surf Attack From Russia
*/
``` ```
#### Search #### Search
Issue a search query to discogs database. This endpoint accepts pagination parameters Issue a search query to discogs database. This endpoint accepts pagination parameters
Authentication (as any user) is required. Authentication (as any user) is required.
Use `SearchRequest` struc to create a request Use `SearchRequest` struct to create a request
```go ```go
type SearchRequest struct { type SearchRequest struct {
Q string // search query (optional) Q string // search query (optional)
@ -98,4 +90,3 @@ Example
``` ```
etc. etc.
More examples - soon

3
examples/discogs_example.go
View File

@ -7,8 +7,7 @@ import (
) )
func main() { func main() {
d := discogs.NewClient().UserAgent("TestDiscogsClient/0.0.1 +http://irlndts.moscow") //.Token("oQTQKAprakIQfWOkAxTdYyDpgUqahHtdbHTuYkIy") d := discogs.NewClient().UserAgent("TestDiscogsClient/0.0.1 +http://example.com")
if err := d.Currency("EUR"); err != nil { if err := d.Currency("EUR"); err != nil {
fmt.Println(err) fmt.Println(err)
return return