https://github.com/purplebooth/go-zkillboard-redisq
This is a go client for the RedisQ service from zKillboard.
https://github.com/purplebooth/go-zkillboard-redisq
client eve-online go golang zkillboard
Last synced: 3 months ago
JSON representation
This is a go client for the RedisQ service from zKillboard.
- Host: GitHub
- URL: https://github.com/purplebooth/go-zkillboard-redisq
- Owner: PurpleBooth
- License: mit
- Created: 2017-06-29T23:18:28.000Z (almost 8 years ago)
- Default Branch: main
- Last Pushed: 2020-06-09T20:57:18.000Z (about 5 years ago)
- Last Synced: 2025-01-30T10:44:14.566Z (4 months ago)
- Topics: client, eve-online, go, golang, zkillboard
- Language: Go
- Homepage: https://github.com/zKillboard/RedisQ
- Size: 8.79 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# zKillboard RedisQ Client
This is a go client for the RedisQ service from zKillboard. This is a service that creates a push interface for
consumers to be notified of kills.
## Installing
```bash
go get -u -v github.com/purplebooth/go-zkillboard-redisq
```
## Running
To listen once
```go
z := zkillboard_redisq.NewZKillboardRedisQClient()
killPackage, apiErrs := z.ListenOnce()
```
To listen continuously
```go
errs := make(chan error)
defer close(errs)
kills := make(chan *zkillboard_redisq.Package)
defer close(kills)
z := zkillboard_redisq.NewZKillboardRedisQClient()
z.Listen(kills, errs)
```
The continuous listen endpoint is largely there for simple apps, and I expect you will need to create your own variant
to achieve what you'd like for more expressive apps.
More detailed documentation can be found in the [godoc](https://godoc.org/github.com/PurpleBooth/go-zkillboard-redisq/zkillboard-redisq)
## Demo Client
```bash
$ zkillboard-redisq-cli --help
NAME:
zkillboard-redisq-cli - Print every time a kill comes in. Kills are usually delayed by about 90min
USAGE:
zkillboard-redisq-cli [global options] command [command options] [arguments...]
VERSION:
0.1.0
COMMANDS:
help, h Shows a list of commands or help for one command
GLOBAL OPTIONS:
--developmentLogging, -d Enable more verbose, and more human readable logging [$VERBOSE]
--solarSystem value, -s value Solar Systems to watch for kills in [$SOLAR_SYSTEMS]
--character value, -c value Characters to watch for kills in [$CHARACTERS]
--corporation value, -o value Corporations to watch for kills in [$CORPORATIONS]
--help, -h show help
--auto-complete
--version, -V print only the version
```
## Dependencies
We use the following dependencies:
```bash
go get -u -v github.com/parnurzeal/gorequest
go get -u -v github.com/urfave/cli # Only for the demo CLI
go get -u -v go.uber.org/zap # Only for the demo CLI
```
## License and Contribution
See [LICENSE.md](LICENSE.md)
See [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md)