globe-server 0.0.33__tar.gz

globe_server-0.0.33/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Edward Catley
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

globe_server-0.0.33/PKG-INFO

@@ -0,0 +1,257 @@
+Metadata-Version: 2.4
+Name: globe-server
+Version: 0.0.33
+Summary: Globe Server Backend - Webserver control of Globe
+Author-email: Edward Catley <edward.catley@catleytech.com>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/edcatley/Globe-Software
+Project-URL: Bug Reports, https://github.com/edcatley/Globe-Software/issues
+Project-URL: Source, https://github.com/edcatley/Globe-Software
+Keywords: globe,visualization,server,fastapi,interactive
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: Multimedia :: Graphics :: 3D Modeling
+Classifier: Topic :: Scientific/Engineering :: Visualization
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: fastapi>=0.112.0
+Requires-Dist: uvicorn[standard]>=0.30.5
+Requires-Dist: pydantic>=2.8.2
+Requires-Dist: python-multipart>=0.0.9
+Requires-Dist: psutil>=5.8.0
+Requires-Dist: requests>=2.31.0
+Requires-Dist: aiofiles>=23.2.1
+Requires-Dist: aiosqlite>=0.19.0
+Requires-Dist: pyserial>=3.5
+Requires-Dist: python-vlc>=3.0.20000
+Requires-Dist: websockets>=12.0
+Requires-Dist: zeroconf>=0.39.4
+Requires-Dist: aiohttp>=3.9.0
+Requires-Dist: numpy>=1.26.0
+Requires-Dist: sqlalchemy>=2.0.0
+Requires-Dist: earth-viz
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Requires-Dist: pytest-asyncio>=0.21.0; extra == "dev"
+Requires-Dist: black>=22.0; extra == "dev"
+Requires-Dist: flake8>=5.0; extra == "dev"
+Requires-Dist: mypy>=1.0; extra == "dev"
+Dynamic: license-file
+
+# Globe Software
+
+Complete interactive globe visualization system with hardware control, media playback, and web interface.
+
+## Overview
+
+Globe Software is a complete system for controlling and visualizing content on a physical rotating globe display. This package includes both the FastAPI backend server and the React web interface as static files.
+
+WARNING: This package is designed to be used on the Globe platform hardware - use on other systems may result in unexpected behaviour like forced network disconnects.
+
+## Features
+
+- **Web Interface**: React-based UI for controlling the globe (served as static files)
+- **FastAPI Backend**: High-performance async web server with REST API
+- **Globe Visualization**: Real-time 3D globe rendering with earth-viz
+- **Media Management**: Upload and manage video/image content with playlist support
+- **Hardware Control**: Interface with ESP32 (motor) and FPGA (display) hardware
+- **Network Management**: WiFi configuration, network switching, and access point mode
+- **Automatic Updates**: Online (PyPI) and offline (.whl) update support
+- **Real-time Communication**: WebSocket support for live status updates
+
+## Installation
+
+### Quick Install
+```bash
+pip install globe-server
+```
+
+### Initial Setup
+After installation, run the setup wizard to configure the system:
+```bash
+globe-server-setup
+```
+
+This will:
+- Create the `~/.globe-server/` directory structure
+- Download required static images for visualization
+- Prompt for configuration (ESP32 API key, WiFi credentials, etc.)
+
+### Production Deployment (Raspberry Pi)
+
+For production deployment on Raspberry Pi, see the [installation guide](https://github.com/edcatley/Globe-Software/blob/main/INSTALL.md) which covers:
+- Creating the installation directory and virtual environment
+- Installing as a systemd service
+- Automatic startup and update management
+
+## Usage
+
+### Starting the Server
+```bash
+# Start the server
+globe-server
+```
+
+The server will start on `http://localhost:8000` and serve:
+- Web interface at `http://localhost:8000/`
+- API documentation at `http://localhost:8000/docs`
+- Alternative API docs at `http://localhost:8000/redoc`
+
+### Accessing the Web Interface
+
+Once the server is running, open your browser to:
+- `http://localhost:8000` (local access)
+- `http://<raspberry-pi-ip>:8000` (remote access)
+
+The web interface provides:
+- Media upload and playlist management
+- Globe visualization controls
+- Motor speed and rotation control
+- Network and WiFi configuration
+- System settings and firmware updates
+
+### Command Line Options
+```bash
+# Start with default settings
+globe-server
+
+# Or use uvicorn directly for custom configuration
+uvicorn globe_server.main:app --host 0.0.0.0 --port 8000 --reload
+```
+
+## Configuration
+
+The server stores configuration and data in `~/.globe-server/`:
+
+- `.env` - Environment variables (API keys, WiFi credentials)
+- `globe.db` - SQLite database
+- `media/` - Uploaded media files
+- `updates/` - Software update packages (.whl files)
+- `logs/` - Application logs
+
+Key configuration settings (from `globe_server.config`):
+- `GLOBE_DATA_DIR`: `~/.globe-server` (base directory)
+- `GLOBE_MEDIA_DIRECTORY`: Media storage location
+- `UPDATE_DIRECTORY`: Software update packages
+- `MOTOR_RPM`: Default motor rotation speed
+- `ESP32_API_KEY`: Authentication for ESP32 communication
+
+## System Architecture
+
+```
+┌─────────────────┐
+│  Web Interface  │ (React - served as static files)
+│  Port 8000      │
+└────────┬────────┘
+         │ HTTP/WebSocket
+┌────────▼────────┐
+│  FastAPI Server │ (Python)
+│  Port 8000      │
+└────┬───────┬────┘
+     │       │
+     │       └──────────┐
+┌────▼────┐      ┌──────▼──────┐
+│  ESP32  │      │    FPGA     │
+│ (Motor) │      │ (Display)   │
+└─────────┘      └─────────────┘
+```
+
+## API Endpoints
+
+The REST API provides programmatic access to all features:
+
+- `/` - Web interface (static files)
+- `/media/*` - Media file management and playback
+- `/playlist/*` - Playlist operations
+- `/motor/*` - Motor control (ESP32)
+- `/status/*` - Server status and WebSocket updates
+- `/settings/*` - Server configuration
+- `/update/*` - Software and firmware updates (server, ESP32, FPGA)
+- `/network/*` - Network and WiFi management
+- `/earth-viz/*` - Globe visualization rendering
+
+Full interactive API documentation available at `/docs` when server is running.
+
+## Software Updates
+
+Globe Software supports both online and offline updates:
+
+### Online Updates (PyPI)
+When connected to the internet, the system automatically checks for updates on startup (when using the systemd service).
+
+### Offline Updates
+For systems without internet access:
+1. Download the update bundle (`.whl` files for the package and all dependencies)
+2. Copy all `.whl` files to `~/.globe-server/updates/`
+3. Restart the server
+
+The startup script will automatically install from local files if PyPI is unavailable.
+
+## Development
+
+### From Source
+```bash
+git clone https://github.com/edcatley/Globe-Software.git
+cd Globe-Software/backend
+pip install -e .[dev]
+```
+
+### Running Tests
+```bash
+pytest
+```
+
+### Code Quality
+```bash
+# Format code
+black src/
+
+# Type checking
+mypy src/
+```
+
+## Links
+
+- **GitHub Repository**: https://github.com/edcatley/Globe-Software
+- **Issue Tracker**: https://github.com/edcatley/Globe-Software/issues
+- **Installation Guide**: https://github.com/edcatley/Globe-Software/blob/main/INSTALL.md
+
+## Requirements
+
+### Software
+- Python 3.8 or higher
+- VLC media player (for video/image playback)
+
+### Hardware (Optional)
+- Raspberry Pi (tested on Bookworm)
+- ESP32 microcontroller (for motor control)
+- FPGA (for display control)
+
+The system can run without hardware for development and testing.
+
+### Python Dependencies
+All Python dependencies are automatically installed:
+- FastAPI & Uvicorn (web server)
+- SQLite (database)
+- VLC Python bindings (media playback)
+- PyQt5 & PyQtWebEngine (visualization windows)
+- earth-viz (globe rendering)
+- pyserial (UART communication)
+- zeroconf (network discovery)
+
+See the [pyproject.toml](https://github.com/edcatley/Globe-Software/blob/main/backend/pyproject.toml) for the complete dependency list.
+
+## Author
+
+Edward Catley (edward.catley@catleytech.com)
+
+## License
+
+MIT License - see [LICENSE](https://github.com/edcatley/Globe-Software/blob/main/backend/LICENSE) for details

globe_server-0.0.33/README.md

@@ -0,0 +1,210 @@
+# Globe Software
+
+Complete interactive globe visualization system with hardware control, media playback, and web interface.
+
+## Overview
+
+Globe Software is a complete system for controlling and visualizing content on a physical rotating globe display. This package includes both the FastAPI backend server and the React web interface as static files.
+
+WARNING: This package is designed to be used on the Globe platform hardware - use on other systems may result in unexpected behaviour like forced network disconnects.
+
+## Features
+
+- **Web Interface**: React-based UI for controlling the globe (served as static files)
+- **FastAPI Backend**: High-performance async web server with REST API
+- **Globe Visualization**: Real-time 3D globe rendering with earth-viz
+- **Media Management**: Upload and manage video/image content with playlist support
+- **Hardware Control**: Interface with ESP32 (motor) and FPGA (display) hardware
+- **Network Management**: WiFi configuration, network switching, and access point mode
+- **Automatic Updates**: Online (PyPI) and offline (.whl) update support
+- **Real-time Communication**: WebSocket support for live status updates
+
+## Installation
+
+### Quick Install
+```bash
+pip install globe-server
+```
+
+### Initial Setup
+After installation, run the setup wizard to configure the system:
+```bash
+globe-server-setup
+```
+
+This will:
+- Create the `~/.globe-server/` directory structure
+- Download required static images for visualization
+- Prompt for configuration (ESP32 API key, WiFi credentials, etc.)
+
+### Production Deployment (Raspberry Pi)
+
+For production deployment on Raspberry Pi, see the [installation guide](https://github.com/edcatley/Globe-Software/blob/main/INSTALL.md) which covers:
+- Creating the installation directory and virtual environment
+- Installing as a systemd service
+- Automatic startup and update management
+
+## Usage
+
+### Starting the Server
+```bash
+# Start the server
+globe-server
+```
+
+The server will start on `http://localhost:8000` and serve:
+- Web interface at `http://localhost:8000/`
+- API documentation at `http://localhost:8000/docs`
+- Alternative API docs at `http://localhost:8000/redoc`
+
+### Accessing the Web Interface
+
+Once the server is running, open your browser to:
+- `http://localhost:8000` (local access)
+- `http://<raspberry-pi-ip>:8000` (remote access)
+
+The web interface provides:
+- Media upload and playlist management
+- Globe visualization controls
+- Motor speed and rotation control
+- Network and WiFi configuration
+- System settings and firmware updates
+
+### Command Line Options
+```bash
+# Start with default settings
+globe-server
+
+# Or use uvicorn directly for custom configuration
+uvicorn globe_server.main:app --host 0.0.0.0 --port 8000 --reload
+```
+
+## Configuration
+
+The server stores configuration and data in `~/.globe-server/`:
+
+- `.env` - Environment variables (API keys, WiFi credentials)
+- `globe.db` - SQLite database
+- `media/` - Uploaded media files
+- `updates/` - Software update packages (.whl files)
+- `logs/` - Application logs
+
+Key configuration settings (from `globe_server.config`):
+- `GLOBE_DATA_DIR`: `~/.globe-server` (base directory)
+- `GLOBE_MEDIA_DIRECTORY`: Media storage location
+- `UPDATE_DIRECTORY`: Software update packages
+- `MOTOR_RPM`: Default motor rotation speed
+- `ESP32_API_KEY`: Authentication for ESP32 communication
+
+## System Architecture
+
+```
+┌─────────────────┐
+│  Web Interface  │ (React - served as static files)
+│  Port 8000      │
+└────────┬────────┘
+         │ HTTP/WebSocket
+┌────────▼────────┐
+│  FastAPI Server │ (Python)
+│  Port 8000      │
+└────┬───────┬────┘
+     │       │
+     │       └──────────┐
+┌────▼────┐      ┌──────▼──────┐
+│  ESP32  │      │    FPGA     │
+│ (Motor) │      │ (Display)   │
+└─────────┘      └─────────────┘
+```
+
+## API Endpoints
+
+The REST API provides programmatic access to all features:
+
+- `/` - Web interface (static files)
+- `/media/*` - Media file management and playback
+- `/playlist/*` - Playlist operations
+- `/motor/*` - Motor control (ESP32)
+- `/status/*` - Server status and WebSocket updates
+- `/settings/*` - Server configuration
+- `/update/*` - Software and firmware updates (server, ESP32, FPGA)
+- `/network/*` - Network and WiFi management
+- `/earth-viz/*` - Globe visualization rendering
+
+Full interactive API documentation available at `/docs` when server is running.
+
+## Software Updates
+
+Globe Software supports both online and offline updates:
+
+### Online Updates (PyPI)
+When connected to the internet, the system automatically checks for updates on startup (when using the systemd service).
+
+### Offline Updates
+For systems without internet access:
+1. Download the update bundle (`.whl` files for the package and all dependencies)
+2. Copy all `.whl` files to `~/.globe-server/updates/`
+3. Restart the server
+
+The startup script will automatically install from local files if PyPI is unavailable.
+
+## Development
+
+### From Source
+```bash
+git clone https://github.com/edcatley/Globe-Software.git
+cd Globe-Software/backend
+pip install -e .[dev]
+```
+
+### Running Tests
+```bash
+pytest
+```
+
+### Code Quality
+```bash
+# Format code
+black src/
+
+# Type checking
+mypy src/
+```
+
+## Links
+
+- **GitHub Repository**: https://github.com/edcatley/Globe-Software
+- **Issue Tracker**: https://github.com/edcatley/Globe-Software/issues
+- **Installation Guide**: https://github.com/edcatley/Globe-Software/blob/main/INSTALL.md
+
+## Requirements
+
+### Software
+- Python 3.8 or higher
+- VLC media player (for video/image playback)
+
+### Hardware (Optional)
+- Raspberry Pi (tested on Bookworm)
+- ESP32 microcontroller (for motor control)
+- FPGA (for display control)
+
+The system can run without hardware for development and testing.
+
+### Python Dependencies
+All Python dependencies are automatically installed:
+- FastAPI & Uvicorn (web server)
+- SQLite (database)
+- VLC Python bindings (media playback)
+- PyQt5 & PyQtWebEngine (visualization windows)
+- earth-viz (globe rendering)
+- pyserial (UART communication)
+- zeroconf (network discovery)
+
+See the [pyproject.toml](https://github.com/edcatley/Globe-Software/blob/main/backend/pyproject.toml) for the complete dependency list.
+
+## Author
+
+Edward Catley (edward.catley@catleytech.com)
+
+## License
+
+MIT License - see [LICENSE](https://github.com/edcatley/Globe-Software/blob/main/backend/LICENSE) for details

globe_server-0.0.33/pyproject.toml

@@ -0,0 +1,84 @@
+[build-system]
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "globe-server"
+version = "0.0.33"
+authors = [
+    {name = "Edward Catley", email = "edward.catley@catleytech.com"},
+]
+description = "Globe Server Backend - Webserver control of Globe"
+readme = "README.md"
+license = "MIT"
+requires-python = ">=3.8"
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Operating System :: OS Independent",
+    "Topic :: Multimedia :: Graphics :: 3D Modeling",
+    "Topic :: Scientific/Engineering :: Visualization",
+]
+keywords = ["globe", "visualization", "server", "fastapi", "interactive"]
+
+dependencies = [
+    "fastapi>=0.112.0",
+    "uvicorn[standard]>=0.30.5",
+    "pydantic>=2.8.2",
+    "python-multipart>=0.0.9",
+    "psutil>=5.8.0",
+    "requests>=2.31.0",
+    "aiofiles>=23.2.1",
+    "aiosqlite>=0.19.0",
+    "pyserial>=3.5",
+    "python-vlc>=3.0.20000",
+    "websockets>=12.0",
+    "zeroconf>=0.39.4",
+    "aiohttp>=3.9.0",
+    "numpy>=1.26.0",
+    "sqlalchemy>=2.0.0",
+    "earth-viz",
+]
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=7.0",
+    "pytest-asyncio>=0.21.0",
+    "black>=22.0",
+    "flake8>=5.0",
+    "mypy>=1.0",
+]
+
+[project.scripts]
+globe-server = "globe_server.main:main"
+globe-server-setup = "globe_server.setup:main"
+
+[project.urls]
+Homepage = "https://github.com/edcatley/Globe-Software"
+"Bug Reports" = "https://github.com/edcatley/Globe-Software/issues"
+"Source" = "https://github.com/edcatley/Globe-Software"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools.package-data]
+globe_server = [
+    "planet_vis/resources/maps/*.jpg",
+    "planet_vis/resources/maps/*.png",
+    "static/**/*",
+]
+
+[tool.black]
+line-length = 88
+target-version = ['py38']
+
+[tool.mypy]
+python_version = "3.8"
+warn_return_any = true
+warn_unused_configs = true
+disallow_untyped_defs = true

globe_server-0.0.33/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

globe_server-0.0.33/src/globe_server/__init__.py

@@ -0,0 +1,5 @@
+"""Globe Server Backend Package"""
+
+__version__ = "0.1.0"
+__author__ = "Edward Catley"
+__description__ = "Globe Server Backend - Webserver control of Globe"

globe_server-0.0.33/src/globe_server/api/__init__.py

@@ -0,0 +1,22 @@
+from fastapi import APIRouter
+from .status import router as status_router
+from .media import router as media_router
+from .motor import router as motor_router
+from .playlist import router as playlist_router
+from .playback import router as playback_router
+from .update import router as update_router
+from .settings import router as settings_router
+from .version import router as version_router
+
+
+api_router = APIRouter()
+
+api_router.include_router(status_router)
+api_router.include_router(media_router)
+api_router.include_router(motor_router)
+api_router.include_router(playlist_router)
+api_router.include_router(playback_router)
+api_router.include_router(update_router)
+api_router.include_router(settings_router)
+api_router.include_router(version_router)
+