bracket-creator

command module
v0.1.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 21, 2023 License: Apache-2.0 Imports: 1 Imported by: 0

README

Logo

bracket-creator

GitHub release (latest SemVer including pre-releases) goreleaser Go reference License Apache 2.0
codeql Go report card


A CLI to create kendo tournament brackets

Usage

You will need to compile the binary from source or download a release from github, if one is available.

To learn how to use the CLI run:

bc --help

Example usage:

make go/build && ./bin/bracket-creator create -s -f ./mock_data.csv -o ./output.xlsx

CSV format for individual matches should be (see mock_data.csv for an example):

First_Name Last_Name, Dojo

For teams, it shoud be one team per line.

Paramaters

  • -h - Show help
  • -f - Path to the CSV file containing the players/teams in Name, Dojo format. Dojo is a field to ensure players/teams don't endup fighting someone of the same dojo
  • -o - Path to write the output excel file
  • -r - Round robin, to ensure that in a pool of 4 or more, everyone would fight everyone. Otherwise, everyone fights only twice in their pool.
  • -p - Minimum number of players/teams per pool. Extra players are added to the end of the pool if there are more than expected.
  • -s - Sanatize print names into first name initial and capitalize the last name. This is useful for individual tournaments.

Install - WIP

You can install the pre-compiled binary (in several ways), use Docker or compile from source (when on OSS).

Below you can find the steps for each of them.

homebrew tap

brew install gitrgoliveira/tap/bracket-creator

apt

echo 'deb [trusted=yes] https://apt.fury.io/gitrgoliveira/ /' | sudo tee /etc/apt/sources.list.d/gitrgoliveira.list
sudo apt update
sudo apt install bracket-creator

yum

echo '[gitrgoliveira]
name=Gemfury gitrgoliveira repository
baseurl=https://yum.fury.io/gitrgoliveira/
enabled=1
gpgcheck=0' | sudo tee /etc/yum.repos.d/gitrgoliveira.repo
sudo yum install goreleaser

deb, rpm and apk packages

Download the .deb, .rpm or .apk packages from the [release page](https://github.com/gitrgoliveira/bracket-creator/releases) and install them with the appropriate tools.

go install

go install github.com/gitrgoliveira/bracket-creator@latest

from the GitHub releases

Download the pre-compiled binaries from the release page page and copy them to the desired location.

$ VERSION=v1.0.0
$ OS=Linux
$ ARCH=x86_64
$ TAR_FILE=bracket-creator_${OS}_${ARCH}.tar.gz
$ wget https://github.com/gitrgoliveira/bracket-creator/releases/download/${VERSION}/${TAR_FILE}
$ sudo tar xvf ${TAR_FILE} bracket-creator -C /usr/local/bin
$ rm -f ${TAR_FILE}

manually

$ git clone github.com/gitrgoliveira/bracket-creator
$ cd bracket-creator
$ go generate ./...
$ go install

Contribute to this repository

This project adheres to the Contributor Covenant code of conduct. By participating, you are expected to uphold this code. We appreciate your contribution. Please refer to our contributing guidelines for further information.

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
Package cmd handle the cli commands
Package cmd handle the cli commands
internal

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL