Giter Club home page Giter Club logo

tml's Introduction

Training Markup Language

TML stands for Training Markup Language. TML is a markup language aiming at providing a simple and clean way to describe a training/workout with the exercises and the performances.

Example

I really enjoyed my workout because of my TML logs!

# Squat
150kg x 5 @ 7
160kg x 5 @ 8
160kg x 5 @ 8
160kg x 5 @ 9
my squat session felt really great! I hit my RPEs seamlessly!

# Deadlift
150kg x 5 @ 7
160kg x 5 @ 8
160kg x 5 @ 8
160kg x 5 @ 9
my deadlift session felt really great! I hit my RPEs seamlessly!

# Push ups
25 x 4
it felt really hard, trust me!

Installation

go get -u github.com/yanishoss/tml

Parsing in Go

package main

import (
    "fmt"
    "github.com/yanishoss/tml"
)

func main() {
    input := `
I really enjoyed my workout because of my TML logs!

# Squat
150kg x 5 @ 7
160kg x 5 @ 8
160kg x 5 @ 8
160kg x 5 @ 9
my squat session felt really great! I hit my RPEs seamlessly!

# Deadlift
150kg x 5 @ 7
160kg x 5 @ 8
160kg x 5 @ 8
160kg x 5 @ 9
my deadlift session felt really great! I hit my RPEs seamlessly!
`

    workout, err := tml.Parse(input, tml.WithDefaultConfig())

    if err != nil {
        panic(err)
    }
    
    // Play with the workout object
    
    fmt.Println("Workout's comment: ", *workout.Comment)
    fmt.Println("Workout's exercises number: ", len(workout.Exercises))

    return 
}

Types

package parser

type Row struct {
	Sets   int      `json:"sets"`
	Reps   int      `json:"reps"`
	RPE    *float64 `json:"rpe,omitempty"`
	Weight float64  `json:"weight"`
	Unit   string   `json:"unit"`
}

type Exercise struct {
	Name    string  `json:"name"`
	Rows    []Row   `json:"rows"`
	Comment *string `json:"comment,omitempty"`
}

type Workout struct {
	Comment   *string    `json:"comment,omitempty"`
	Exercises []Exercise `json:"exercises"`
}

type Config struct {
	DefaultUnit string
	ValidUnits  []string
	RPERange    [2]float64
}

Acknowledgments

I have gotten this idea from weightroom.uk as I was using their app to track my Powerlifting progression.

tml's People

Contributors

yanishoss avatar

Stargazers

Francis Muturi avatar  avatar

Watchers

James Cloos avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.