gravl

README

Overview

gravl command line clients for activity-related services

Activity clients

• Strava
• Cycling Analytics
• Ride with GPS
• Zwift

Documentation

• manual

Documentation

Index

• Constants
• Variables
• func Afters(afs ...cli.AfterFunc) cli.AfterFunc
• func Befores(bfs ...cli.BeforeFunc) cli.BeforeFunc
• func Stats(c *cli.Context) error
• func Token(n int) (string, error)
• type Encoder
  • func Blackhole() Encoder
  • func GPX(writer io.Writer, compact bool) Encoder
  • func GeoJSON(writer io.Writer, compact bool) Encoder
  • func JSON(writer io.Writer, compact bool) Encoder
  • func XML(writer io.Writer, compact bool) Encoder
• type ExporterFunc
• type Rt
  • func Runtime(c *cli.Context) *Rt
• type UploaderFunc

Constants

const RuntimeKey = "github.com/bzimmer/gravl#RuntimeKey"

Variables

var ErrUnknownEncoder = errors.New("unknown encoder")

Functions

func Afters

func Afters(afs ...cli.AfterFunc) cli.AfterFunc

Afters combines multiple `cli.AfterFunc`s into a single `cli.AfterFunc`

func Befores

func Befores(bfs ...cli.BeforeFunc) cli.BeforeFunc

Befores combines multiple `cli.BeforeFunc`s into a single `cli.BeforeFunc`

func Stats

func Stats(c *cli.Context) error

Stats logs and encodes (if requested) the stats

func Token

func Token(n int) (string, error)

Token produces a random token of length `n`

Types

type Encoder

type Encoder interface {
	Encode(v any) error
}

func Blackhole

func Blackhole() Encoder

func GPX

func GPX(writer io.Writer, compact bool) Encoder

func GeoJSON

func GeoJSON(writer io.Writer, compact bool) Encoder

func JSON

func JSON(writer io.Writer, compact bool) Encoder

func XML

func XML(writer io.Writer, compact bool) Encoder

type ExporterFunc

type ExporterFunc func(c *cli.Context) (activity.Exporter, error)

type Rt

type Rt struct {
	// Metadata
	Start time.Time

	// Activity clients
	Zwift            *zwift.Client
	Strava           *strava.Client
	RideWithGPS      *rwgps.Client
	CyclingAnalytics *cyclinganalytics.Client
	InReach          *inreach.Client

	// Endpoints
	Endpoints map[string]oauth2.Endpoint

	// Export / Upload
	Exporters map[string]ExporterFunc
	Uploaders map[string]UploaderFunc

	// IO
	Fs      afero.Fs
	Encoder Encoder

	// Metrics
	Metrics *metrics.Metrics
	Sink    *metrics.InmemSink

	// Evaluation
	Filterer  func(string) (eval.Filterer, error)
	Evaluator func(string) (eval.Evaluator, error)
}

Rt holds the gravl runtime

func Runtime

func Runtime(c *cli.Context) *Rt

type UploaderFunc

type UploaderFunc func(c *cli.Context) (activity.Uploader, error)