Metadata-Version: 2.4
Name: telemetry_server
Version: 0.3.2
Summary: Telemetry server for Autoboat
Project-URL: Github, https://github.com/autoboat-vt/telemetry_server
Project-URL: Documentation, https://autoboat-vt.github.io/documentation
Description-Content-Type: text/markdown
Requires-Dist: Flask<4.0,>=3.1
Requires-Dist: Flask-SQLAlchemy<4.0,>=3.1
Requires-Dist: gunicorn<24.0,>=23.0
Requires-Dist: blinker<2.0,>=1.9
Requires-Dist: click<9.0,>=8.2
Requires-Dist: itsdangerous<3.0,>=2.2
Requires-Dist: Jinja2<4.0,>=3.1
Requires-Dist: MarkupSafe<4.0,>=3.0
Requires-Dist: packaging<26.0,>=25.0
Requires-Dist: SQLAlchemy<3.0,>=2.0
Requires-Dist: Werkzeug<4.0,>=3.1
Provides-Extra: dev
Requires-Dist: build<2.0,>=1.3; extra == "dev"
Requires-Dist: pyproject_hooks<2.0,>=1.2; extra == "dev"
Requires-Dist: annotated-types<1.0,>=0.7; extra == "dev"
Requires-Dist: typing_extensions<5.0,>=4.14; extra == "dev"
Requires-Dist: typing-inspection<1.0,>=0.4; extra == "dev"

# Autoboat Telemetry Server

A lightweight Flask-based web server to collect, display, and manage telemetry data from the Virginia Tech Autoboat project.

## 📦 Project Structure

```txt
autoboat_telemetry_server/
├── __init__.py                   # App factory
├── models.py                     # Database models
├── types.py                      # Custom types and enums
├── routes
    ├── __init__.py               # Routes initialization
    ├── autopilot_parameters.py   # Autopilot parameters routes
    ├── boat_status.py            # Boat status routes
    ├── waypoints.py              # Waypoints management routes
    ├── instance_manager.py       # Instance management routes

instance/
    ├── config.py                 # Configuration file
    ├── app.db                    # Database file
```

## 🚀 Quick Start

### Installation

```bash
pip install -e .
```

### Running the server

1. Production ([Gunicorn](https://gunicorn.org/)):

    ```bash
    gunicorn "autoboat_telemetry_server:create_app()"
    ```

2. Development (Flask):

    ```bash
    flask run
    ```

## Server (Long term)

### Installation

```bash
git clone https://github.com/autoboat-vt/telemetry_server
cd telemetry_server
./server_files/install.sh
```
