Metadata-Version: 2.1
Name: tflstatuscli
Version: 0.1.4
Summary: Query TFL tube line status
Author: stevenb92
Author-email: stevenb92@icloud.com
Requires-Python: >=3.9,<4.0
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Dist: requests (>=2.31.0,<3.0.0)
Requires-Dist: rich (>=13.5.2,<14.0.0)
Requires-Dist: typer (>=0.9.0,<0.10.0)
Description-Content-Type: text/markdown

# tflstatuscli
tflstatuscli is a Python CLI written using the Typer CLI framework for querying the TFL Tube line statuses

## Installation
```bash
pip install tflstatuscli
```

## Usage
### Show status of all tube lines
```bash
tflcli status   
```

### Show status of particular tube line
```bash
tflcli status --line <line_name>
```
NOTE: When searching a particular tube line, validity is checked against the TFL APIs list of tube lines which at the time of writing this includes;
- Bakerloo 
- Central            
- Circle             
- District           
- Hammersmith & City 
- Jubilee            
- Metropolitan                                         
- Northern           
- Piccadilly         
- Victoria           
- Waterloo & City

### Show all disruptions on TFL tube lines
```bash
tflcli disruptions
```

## Poetry Usage
Run these commands within project root dir with python poetry installed.

### Install package and dependancies locally
```bash
poetry install
```

### Run tests 
```bash
poetry run pytest -v
``` 

### Build wheel 
```
poetry build
```
NOTE: Wheel located under /dist in project root dir


