Metadata-Version: 2.1
Name: BoatBuddy
Version: 0.8.13
Summary: A suite of tools to help collecting NMEA0183 and other marine metrics in a digital logbook format
Project-URL: Homepage, https://boatbuddy.site
Project-URL: Bug Tracker, https://github.com/joezeitouny/BoatBuddy/issues
Author-email: Joe Zeitouny <joezeitouny@gmail.com>
License-File: LICENSE
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.7
Requires-Dist: events~=0.4
Requires-Dist: flask~=2.2.3
Requires-Dist: geopy~=2.3.0
Requires-Dist: gpxpy~=1.5.0
Requires-Dist: keyring~=23.13.1
Requires-Dist: latloncalc~=1.5.3
Requires-Dist: mysql-connector-python~=8.0.32
Requires-Dist: numpy~=1.24.1
Requires-Dist: openpyxl~=3.0.10
Requires-Dist: playsound~=1.3.0
Requires-Dist: pymodbustcp~=0.2.0
Requires-Dist: pyobjc~=9.0.1; sys_platform == 'darwin'
Requires-Dist: pyserial
Requires-Dist: python-telegram-bot~=20.6
Requires-Dist: rich~=13.3.1
Requires-Dist: yagmail~=0.15.293
Description-Content-Type: text/markdown

# BoatBuddy

[![Alt text](https://img.shields.io/pypi/v/boatbuddy.svg?style=flat-square)](https://pypi.python.org/pypi/boatbuddy/) [![Alt text](https://img.shields.io/github/license/joezeitouny/boatbuddy)](https://pypi.python.org/pypi/boatbuddy/)

A suite of tools to help collecting NMEA0183 and other marine metrics in a digital logbook format.

### Installation

**Requirements:	Python 3.x >= 3.5**

`BoatBuddy` can be installed via `pip` or an equivalent via:

```console
$ pip install BoatBuddy
```

#### From Source

You can install `BoatBuddy` from source just as you would install any other Python package:

```console
$ pip install git+https://github.com/joezeitouny/BoatBuddy.git
```

This will allow you to keep up to date with development on GitHub:

```console
$ pip install -U git+https://github.com/joezeitouny/BoatBuddy.git
```

### Features

- Ability to generate Excel and / or CSV logs
- Generate GPX file with GPS coordinates combined with timestamps
- Ability to generate a summary log for each session
- Sessions can be tied by the NMEA server, Victron system availability or by a specified time interval

### Usage

```console
$ python -m BoatBuddy --config=CONFIGURATION_FILENAME [options]
```

Where CONFIGURATION_FILENAME points to the file where the JSON configuration file is located on your system.

For the full list of available options

```console
$ python -m BoatBuddy --help
```
