Skip to main content

hop3-installer

Installation toolkit for deploying Hop3 to servers and containers.

Overview

hop3-installer provides two main tools:

  • hop3-install: Production installer for end users and sysadmins
  • hop3-deploy-server: Developer tool for deploying during development

The installers use only Python standard library, making them easy to distribute as single-file scripts.

Features

  • Single-file distribution: Bundle into standalone Python scripts
  • No dependencies: Uses only Python stdlib for maximum portability
  • Multiple backends: Deploy to Docker containers or remote servers via SSH
  • Developer workflow: Deploy local code changes for testing

Installation

pip install hop3-installer

Quick Start

Production Installation (hop3-install)

# Install hop3-cli on local machine
hop3-install cli

# Install hop3-server on current machine (run as root)
sudo hop3-install server

# Or use the one-liner
curl -LsSf https://hop3.cloud/install-server.py | sudo python3 -

Developer Deployment (hop3-deploy-server)

# Deploy to remote server
export HOP3_DEV_HOST=server.example.com
hop3-deploy-server

# Deploy with local code changes
hop3-deploy-server --from local

# Deploy to Docker container
hop3-deploy-server --docker

# Clean installation
hop3-deploy-server --clean

Commands

hop3-install

Subcommand Description
cli Install hop3-cli on local machine
server Install hop3-server (requires root)
bundle Generate single-file installers
test Test installers on Docker or SSH targets

hop3-deploy-server

Option Description
--host HOST Target server hostname
--docker Deploy to Docker container
--local Upload and use local code
--clean Clean existing installation
--teardown Remove Docker container

Architecture

hop3-installer/
├── src/hop3_installer/
│   ├── main.py           # Entry point for hop3-install
│   ├── common.py         # Shared utilities (Colors, Spinner)
│   ├── bundler.py        # Single-file bundler
│   ├── cli/              # CLI installer
│   │   └── installer.py
│   ├── server/           # Server installer
│   │   └── installer.py
│   ├── deployer/         # Developer deployment (hop3-deploy-server)
│   │   ├── cli.py
│   │   ├── deploy.py
│   │   └── backends/     # SSH, Docker backends
│   └── testing/          # Installer validation
│       ├── runner.py
│       └── backends/
└── tests/

Development

# Generate single-file installers
hop3-install bundle --all --output-dir dist/

# Test installers on Docker
hop3-install test docker --distro ubuntu

# Run tests
uv run pytest tests/ -v

# Lint and format
uv run ruff check src/
uv run ruff format src/

Documentation

  • hop3-server - The server component installed by this package
  • hop3-cli - The CLI component installed by this package

License

Apache-2.0 - Copyright (c) 2024-2026, Abilian SAS

Metadata

Release files for hop3-installer 0.8.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for hop3-installer 0.8.1
File Size Uploaded Provenance Actions
hop3_installer-0.8.1.tar.gz 172.6 kB Without provenance Details for hop3_installer-0.8.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for hop3-installer 0.8.1
File Interpreter ABI Platform Actions
hop3_installer-0.8.1-py3-none-any.whl Python 3 none any Details for hop3_installer-0.8.1-py3-none-any.whl

Total release size: 383.6 kB

Release files / hop3_installer-0.8.1.tar.gz

Download URL hop3_installer-0.8.1.tar.gz
Size 172.6 kB
Tags Source
SHA-256 checksum
How to use checksums
7528fd3e7ceabcf450fc1f4542f14dfeeb186b0d22683acd944cab87b9b6f1b8
BLAKE2b-256 checksum
How to use checksums
1071d3dfcb3e8bafc03631e019620355e4020a97e3a4a01aaa60b48a46e5b82e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.12.14

Release files / hop3_installer-0.8.1-py3-none-any.whl

Download URL hop3_installer-0.8.1-py3-none-any.whl
Size 211.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
c55ce9d19c6e874b67530d8118112d6ec6ce735a85784617d6356e4334481225
BLAKE2b-256 checksum
How to use checksums
0ad654fd542d83e49a0e71d6a70f881cf771fdd4f7e3b3cf60f7f198cfc5d40d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.12.14

Security for hop3-installer 0.8.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page