README.md


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59

# NBA

NBA is a simple Python package that provides you with a quick and easy
command-line interface to current NBA scores and standings.

See the Installation & Usage sections below for more information.

# Table of Contents

- [Installation](#installation)
- [Usage](#usage)
- [Contributing](#contributing)

# Installation

[Back to top](#table-of-contents)

## PyPi

```shell
bash pipx install nba-cli
```

## Manual

To run the script locally, run the following commands:

```shell
git clone https://github.com/ccleberg/nba
cd nba
pipx install .
```

![Installation](https://github.com/ccleberg/nba/blob/main/examples/installation.png?raw=true)

# Usage

[Back to top](#table-of-contents)

All commands can be passed to the program with the following template:
`nba <ARGUMENT>`

| Argument      | Shortcut | Description                       |
|---------------|----------|-----------------------------------|
| `--scores`    | `-sc`    | Show today's scoreboard           |
| `--standings` | `-st`    | Show current conference standings |

Scores:
![Scores](https://github.com/ccleberg/nba/blob/main/examples/scores.png?raw=true)

Standings:
![Standings](https://github.com/ccleberg/nba/blob/main/examples/standings.png?raw=true)

# Contributing

[Back to top](#table-of-contents)

Any and all contributions are welcome. Feel free to fork the project,
add features, and submit a pull request.