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.
go get -u github.com/mrz1836/go-preev
Documentation
View the generated documentation
Features
- Client is completely configurable
- Customize the network per request (
main,testorstn) - Using default heimdall http client with exponential backoff & more
- Use your own HTTP client
- Current coverage for the Preev.pro API
- Pairs
- Get All Pairs
- Get Pair By ID
- Tickers
- Get All Tickers
- Get Ticker By Pair ID
- Get Ticker By Pair ID (Historical)
- Pairs
Library Deployment
goreleaser for easy binary or library deployment to Github and can be installed via: brew install goreleaser.
The .goreleaser.yml file is used to configure goreleaser.
Use make release-snap to create a snapshot version of the release, and finally make release to ship to production.
Makefile Commands
View all makefile commands
make help
List of all current commands:
all Runs lint, test-short and vet
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 golangci-lint application (install if not found)
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-ci Runs all tests via CI (exports coverage)
test-ci-no-race Runs all tests via CI (no race) (exports coverage)
test-ci-short Runs unit tests via CI (exports coverage)
test-short Runs vet, lint and tests (excludes integration tests)
uninstall Uninstall the application (and remove files)
update-linter Update the golangci-lint package (macOS only)
vet Run the Go vet application
Examples & Tests
All unit tests and examples run via Github Actions and uses Go version 1.15.x. View the configuration file.
Run all tests (including integration tests)
make test
Run tests (excluding integration tests)
make test-short
Benchmarks
Run the Go benchmarks:
make bench
Code Standards
Read more about this Go project's code standards.
Usage
View the preev examples
Basic implementation:
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 and please follow the code of conduct.
How can I help?
All kinds of contributions are welcome
Credits
Preev for their hard work on the Preev API
6 Nov 6, 2022
55 Oct 6, 2022
13 Jan 7, 2023
1 Apr 14, 2022
14 Dec 20, 2022
0 Nov 28, 2021
1 Oct 30, 2022
2 Sep 27, 2022
70 Nov 21, 2022
11 May 12, 2022
11 Jan 7, 2023
3 Nov 18, 2022
1 Sep 23, 2022
1 Dec 13, 2021
18 Jul 2, 2021
16 Jan 1, 2023
4 Jun 13, 2022