go-preev

:link: Unofficial golang implementation for the Preev API

Description

The unofficial golang implementation for the Preev.pro API

Programming language: Go

License: MIT License

Tags: API     Go Tools     Go     Bitcoin    

README

go-preev

The unofficial golang implementation for the Preev.pro API

Table of Contents

• Installation
• Documentation
• Examples & Tests
• Benchmarks
• Code Standards
• Usage
• Maintainers
• Contributing
• License

Installation

go-preev requires a supported release of Go. ```shell script go get -u github.com/mrz1836/go-preev

<br/>

## Documentation
View the generated [documentation](https://pkg.go.dev/github.com/mrz1836/go-preev)

[![GoDoc](https://godoc.org/github.com/mrz1836/go-preev?status.svg&style=flat)](https://pkg.go.dev/github.com/mrz1836/go-preev)

### Features
- [Client](client.go) is completely configurable
- Customize the network per request (`main`, `test` or `stn`)
- Using default [heimdall http client](https://github.com/gojek/heimdall) with exponential backoff & more
- Use your own HTTP client
- Current coverage for the [Preev.pro API](https://preev.pro/api/)
    - [x] Pairs
        - [x] Get All Pairs
        - [x] Get Pair By ID
    - [x] Tickers
        - [x] Get All Tickers
        - [x] Get Ticker By Pair ID
        - [x] Get Ticker By Pair ID (Historical)

<details>
<summary><strong><code>Library Deployment</code></strong></summary>
<br/>

[goreleaser](https://github.com/goreleaser/goreleaser) for easy binary or library deployment to Github and can be installed via: `brew install goreleaser`.

The [.goreleaser.yml](.goreleaser.yml) file is used to configure [goreleaser](https://github.com/goreleaser/goreleaser).

Use `make release-snap` to create a snapshot version of the release, and finally `make release` to ship to production.
</details>

<details>
<summary><strong><code>Makefile Commands</code></strong></summary>
<br/>

View all `makefile` commands
```shell script
make help

List of all current commands:

clean                  Remove previous builds and any test cache data
clean-mods             Remove all the Go mod cache
coverage               Shows the test coverage
godocs                 Sync the latest tag with GoDocs
help                   Show this help message
install                Install the application
install-go             Install the application (Using Native Go)
lint                   Run the Go lint application
release                Full production release (creates release in Github)
release                Runs common.release then runs godocs
release-snap           Test the full release (build binaries)
release-test           Full production test release (everything except deploy)
replace-version        Replaces the version in HTML/JS (pre-deploy)
run-examples           Runs all the examples
tag                    Generate a new tag and push (tag version=0.0.0)
tag-remove             Remove a tag if found (tag-remove version=0.0.0)
tag-update             Update an existing tag to current commit (tag-update version=0.0.0)
test                   Runs vet, lint and ALL tests
test-short             Runs vet, lint and tests (excludes integration tests)
test-travis            Runs all tests via Travis (also exports coverage)
test-travis-short      Runs unit tests via Travis (also exports coverage)
uninstall              Uninstall the application (and remove files)
vet                    Run the Go vet application

Examples & Tests

All unit tests and [examples](examples/examples.go) run via Travis CI and uses Go version 1.15.x. View the [deployment configuration file](.travis.yml).

Run all tests (including integration tests) ```shell script make test

Run tests (excluding integration tests)
```shell script
make test-short

Benchmarks

Run the Go [benchmarks](preev_test.go): ```shell script make bench

<br/>

## Code Standards
Read more about this Go project's [code standards](CODE_STANDARDS.md).

<br/>

## Usage
View the [preev examples](examples/examples.go)

Basic implementation:
```go
package main

import (
    "fmt"

    "github.com/mrz1836/go-preev"
)

func main() {

    // Create a client
    client := preev.NewClient(nil, nil) 

    // Get pairs
    pairs, _ := client.GetPairs()

    fmt.Println("Found Active Pair(s):", pairs.BsvUsd.Name)
}

Maintainers

MrZ

Contributing

View the [contributing guidelines](CONTRIBUTING.md) and please follow the [code of conduct](CODE_OF_CONDUCT.md).

How can I help?

All kinds of contributions are welcome :raised_hands:! The most basic way to show your support is to star :star2: the project, or to raise issues :speech_balloon:. You can also support this project by becoming a sponsor on GitHub :clap: or by making a bitcoin donation to ensure this journey continues indefinitely! :rocket:

Credits

Preev for their hard work on the Preev API

License