https://github.com/ebc-2in2crc/pixela4go
Pixela (https://pixe.la/) API client for Go.
https://github.com/ebc-2in2crc/pixela4go
4go api-client pixela
Last synced: 5 months ago
JSON representation
Pixela (https://pixe.la/) API client for Go.
- Host: GitHub
- URL: https://github.com/ebc-2in2crc/pixela4go
- Owner: ebc-2in2crc
- License: mit
- Created: 2020-06-02T13:40:51.000Z (about 6 years ago)
- Default Branch: main
- Last Pushed: 2025-04-20T09:04:19.000Z (about 1 year ago)
- Last Synced: 2025-04-20T09:29:11.295Z (about 1 year ago)
- Topics: 4go, api-client, pixela
- Language: Go
- Homepage:
- Size: 71.3 KB
- Stars: 6
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[English](README.md) | [日本語](README_ja.md)
# pixela4go
[](LICENSE)
[](https://pkg.go.dev/github.com/ebc-2in2crc/pixela4go)
[](https://goreportcard.com/report/github.com/ebc-2in2crc/pixela4go)
[](https://img.shields.io/github/release/ebc-2in2crc/pixela4go.svg?label=version)
[Pixela](https://pixe.la/) API client for Go.
[](https://pixe.la/v1/users/ebc-2in2crc/graphs/pixela4go-clone.html)
## Documentation
https://godoc.org/github.com/ebc-2in2crc/pixela4go
## Installation
```
$ go get -u github.com/ebc-2in2crc/pixela4go
```
## Usage
```go
package main
import (
"context"
"log"
pixela "github.com/ebc-2in2crc/pixela4go"
)
func main() {
// Specify the number of retries if you want to retry when the API call is rejected.
// If you do not want to retry, you do not need to specify it.
pixela.RetryCount = 10
client := pixela.New("YOUR_NAME", "YOUR_TOKEN")
// Create new user
uci := &pixela.UserCreateInput{
AgreeTermsOfService: pixela.Bool(true),
NotMinor: pixela.Bool(true),
ThanksCode: pixela.String("thanks-code"),
}
result, err := client.User().CreateWithContext(context.Background(), uci)
if err != nil {
log.Fatal(err)
}
if result.IsSuccess == false {
log.Fatal(result.Message)
}
// Updates the profile information for the user
upi := &pixela.UserProfileUpdateInput{
DisplayName: pixela.String("display-name"),
GravatarIconEmail: pixela.String("gravatar-icon-email"),
Title: pixela.String("title"),
Timezone: pixela.String("Asia/Tokyo"),
AboutURL: pixela.String("https://github.com/ebc-2in2crc"),
ContributeURLs: []string{},
PinnedGraphID: pixela.String("pinned-graph-id"),
}
result, err = client.UserProfile().UpdateWithContext(context.Background(), upi)
if err != nil {
log.Fatal(err)
}
if result.IsSuccess == false {
log.Fatal(result.Message)
}
// Create new graph
gci := &pixela.GraphCreateInput{
ID: pixela.String("graph-id"),
Name: pixela.String("graph-name"),
Unit: pixela.String("commit"),
Type: pixela.String(pixela.GraphTypeInt),
Color: pixela.String(pixela.GraphColorShibafu),
TimeZone: pixela.String("Asia/Tokyo"),
SelfSufficient: pixela.String(pixela.GraphSelfSufficientIncrement),
IsSecret: pixela.Bool(true),
PublishOptionalData: pixela.Bool(true),
}
result, err = client.Graph().CreateWithContext(context.Background(), gci)
if err != nil {
log.Fatal(err)
}
if result.IsSuccess == false {
log.Fatal(result.Message)
}
// Register value
pci := &pixela.PixelCreateInput{
Date: pixela.String("20180915"),
Quantity: pixela.String("5"),
GraphID: pixela.String("graph-id"),
}
result, err = client.Pixel().CreateWithContext(context.Background(), pci)
if err != nil {
log.Fatal(err)
}
if result.IsSuccess == false {
log.Fatal(result.Message)
}
// Create new webhook
wci := &pixela.WebhookCreateInput{
GraphID: pixela.String("graph-id"),
Type: pixela.String(pixela.WebhookTypeIncrement),
}
webhook, err := client.Webhook().CreateWithContext(context.Background(), wci)
if err != nil {
log.Fatal(err)
}
if webhook.IsSuccess == false {
log.Fatal(webhook.Message)
}
// Invoke webhook
wii := &pixela.WebhookInvokeInput{WebhookHash: pixela.String("webhook-hash")}
result, err = client.Webhook().InvokeWithContext(context.Background(), wii)
if err != nil {
log.Fatal(err)
}
if result.IsSuccess == false {
log.Fatal(result.Message)
}
}
```
## Contribution
1. Fork this repository
2. Create your issue branch (`git checkout -b issue/:id`)
3. Change codes
4. Run test suite with the `make test` command and confirm that it passes
5. Run `make fmt`
6. Commit your changes (`git commit -am 'Add some feature'`)
7. Create new Pull Request
## License
[MIT](https://github.com/ebc-2in2crc/pixela4go/blob/master/LICENSE)
## Author
[ebc-2in2crc](https://github.com/ebc-2in2crc)