Skip to main content

Python client for the SparkedHost (Apollo Panel) API — power servers, manage files, run backups.

Project description

sparkedhost

A tiny Python client for the SparkedHost (Apollo Panel) API.

List your servers, hit power buttons, read & write files, manage backups — all behind a small Client / Server API.

Install

pip install git+https://github.com/Jkratz01/sparkedhost.git

Setup

Grab an API key from Apollo → API Credentials, then:

export SPARKEDHOST_API_KEY=your_key_here

(or pass Client(api_key="...") directly.)

Usage

from sparkedhost import Client

client = Client()  # reads SPARKEDHOST_API_KEY

# List your servers
for s in client.list_servers():
    print(s.identifier, s.name)

# Pick one
server = client.server("fd90ffb0-108d-4e24-996a-dc9678174d76")

# Power
server.restart()
server.stop()
server.start()

# Files
server.read_file("server.properties")
server.write_file("server.properties", "motd=hello world\n")
server.replace_in_file("server.properties",
                       old="motd=A Minecraft Server",
                       new="motd=Hello!")
server.delete_files(["bad.log"], root="/logs")

# Backups
server.create_backup(name="pre-update")

See example.py for every operation, and CLAUDE.md for the full API reference.

Using with Claude Code

This repo ships a CLAUDE.md so Claude sessions in this repo are auto-fluent. To get the same in a consuming project, add to that project's CLAUDE.md:

We use sparkedhost — see https://raw.githubusercontent.com/Jkratz01/sparkedhost/main/CLAUDE.md

Or in a one-off Claude Code session, type @https://raw.githubusercontent.com/Jkratz01/sparkedhost/main/CLAUDE.md to load it on demand.

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sparkedhost-0.1.0.tar.gz (5.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

sparkedhost-0.1.0-py3-none-any.whl (6.1 kB view details)

Uploaded Python 3

File details

Details for the file sparkedhost-0.1.0.tar.gz.

File metadata

  • Download URL: sparkedhost-0.1.0.tar.gz
  • Upload date:
  • Size: 5.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.6

File hashes

Hashes for sparkedhost-0.1.0.tar.gz
Algorithm Hash digest
SHA256 17ba2ddc4d8788741a14f8da6267b47b34a970c7780a52177bb0e8d941d4fdd2
MD5 ee11da7243a894e9f481e9d2960590d2
BLAKE2b-256 662f870d163f9a344cb24dac06a49b5bdc44343ecd5f7342590f3a81474137b3

See more details on using hashes here.

File details

Details for the file sparkedhost-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: sparkedhost-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 6.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.6

File hashes

Hashes for sparkedhost-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 6388c656e32c8b340f968df3b619b23d8c1c819beab8b233db19044ce4734e61
MD5 aa4acfa93bafaa8c7b84daae134fe2ac
BLAKE2b-256 09e544f5c53ddf737263db6f743f256c06553b1f0c3b5ed113579ae9913da9d8

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page