beerpong 0.0.0

Bracketing tool with beerpong in mind

Beerpong

Bracketing tool with beerpong in mind

Description

A simple yet powerful bracketing tool with dual window design and beerpong in mind.

Installation

End user

Install the most recent stable build via

pip install beerpong

Developers

Clone the repository via

git clone https://github.com/juhannc/beerpong.git

Afterwards, navigate into the cloned repository and create a install the package via

python3 -m pip install -e .

for basic features.

Or, if you also want to locally run tests, you can use

python3 -m pip install -e '.[tests]'

If you want to have all the dependencies installed, use

python3 -m pip install -e '.[all]'

Finally, to install the pre-commit hooks, run

pre-commit install

Now, prior to any commit, the hooks defined in .pre-commit-config.yaml will be ran. A failure in any hook will block the commit. Although, most of the errors, like formatting, will correct themselves. You just have to re-add all changed files and commit again.

Alternatively, you can run the pipeline at any time to invoke changes before they block commits with

pre-commit run --all-files

Usage

To run the app, simply use

beerpong