irgendwr / go-stine

πŸŽ“ STiNE CLI / library in Go

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

go-stine

Build status Release status Go Report Card GitHub Release

STiNE CLI/library written in Go.

You can find more details about STiNE here:

Demo

asciicast

Installation

Linux

Download and unpack the latest release:

# download
curl -O -L https://github.com/irgendwr/go-stine/releases/latest/download/stine_Linux_x86_64.tar.gz
# unpack
tar -xvzf stine_Linux_x86_64.tar.gz
# copy to folder in $PATH
sudo cp ./stine /usr/bin/stine

Create a file called .stine.yaml (either inside your home folder or the folder containing the program) (e.g. using nano ~/.stine.yaml) and edit it to fit your needs. See config section for examples.

macOS

Download and unpack the latest release:

# download
curl -O -L https://github.com/irgendwr/go-stine/releases/latest/download/stine_Darwin_x86_64.tar.gz
# unpack
tar -xvzf stine_Darwin_x86_64.tar.gz
# add to $PATH
sudo cp ./stine /usr/local/bin
# cleanup
rm stine_Darwin_x86_64.tar.gz stine

Create a file called .stine.yaml (either inside your home folder or the folder containing the program) (e.g. using nano ~/.stine.yaml) and edit it to fit your needs. See config section for examples.

Config

If no config file is specified using the -c/--config flag, the program looks for a file called .stine.yaml in the following paths:

  1. Program directory (path the stine binary is in)
  2. CWD (current working directory)
  3. Home folder

Note: Do not use Tabs! Indent config with spaces instead.

Example:

username: baw1234
password: your-password-here

Usage

List of commands and flags: stine help

Examples

List exams: stine exams

List all exam results: stine examresults -a

Show schedule of a given day: stine schedule 06.07 --day

Show schedule of the current week: stine schedule --week

Show schedule of next week: stine schedule --next --week

Export a schedule: stine schedule export Y2020M07 -o ./2020_07.ics

Build

Run make.

Related Projects

Contributing

Contributions are welcome! Feel free to open an issue, or even better: submit a pull-request.

About

πŸŽ“ STiNE CLI / library in Go

License:MIT License


Languages

Language:Go 98.7%Language:Makefile 1.3%