Metadata-Version: 2.1
Name: cougar-log
Version: 0.1.3
Summary: 
Author: Weaver Goldman
Author-email: we.goldm@gmail.com
Requires-Python: >=3.10,<4.0
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Requires-Dist: Fabric (>=2.7.0,<3.0.0)
Requires-Dist: click-spinner (>=0.1.10,<0.2.0)
Requires-Dist: matplotlib (>=3.5.2,<4.0.0)
Requires-Dist: pandas (>=1.4.3,<2.0.0)
Requires-Dist: tabulate (>=0.8.10,<0.9.0)
Requires-Dist: typer[all] (>=0.4.1,<0.5.0)
Description-Content-Type: text/markdown

# Cougar Log

**Cougar Log is a CLI for rapidly converting and visualizing .wpilog files!**

See the following page for a guide on creating these files inside of an FRC robotics project:

[https://docs.wpilib.org/en/stable/docs/software/telemetry/datalog.html](https://docs.wpilib.org/en/stable/docs/software/telemetry/datalog.html)

## Quickstart

### Installation

Run the following to install `cougar-log` using pip:

```
pip install cougar-log
```

### Basic Usage Examples

_See the documentation below this section for more specific capabilities of this CLI._

In this example, we have a file in our current directory called `my_data_log.wpilog`.

#### Converting to CSV

```
cougar-log convert -i my_data_log.wpilog
```

_or, to convert any file in the given folder:_

```
cougar-log convert -i .
```

#### Displaying as a Table

```
cougar-log table -i my_data_log.wpilog
```

#### Graphing Data

```
cougar-log graph -i my_data_log.wpilog
```

#### Filtering

Any of these commands can be used with a filter flag (`-f/--filter`) in order to select only the entries that have that name.

Use the table option to see the names of all of the log entries.

```
cougar-log graph -i my_data_log.wpilog -f /temps/drive
```

#### Downloading Files from a Robot

Replace XX.XX with your team number in that format.

_Note: this command has a multitude of options available._

```
cougar-log download --host "10.XX.XX.2"
```

## Documentation

Click the link below to visit the documentation:

[frc2539.github.io/cougar-log](https://frc2539.github.io/cougar-log)
