Skip to main content

SporeStack API library and CLI for launching servers with Monero or Bitcoin

Project description

Python 3 library and CLI for SporeStack (SporeStack Tor Hidden Service)

Changelog

Requirements

  • Python 3.8-3.11 (and likely newer)

Running without installing

  • Make sure pipx is installed.
  • pipx run 'sporestack[cli]'

Installation with pipx

  • Make sure pipx is installed.
  • pipx install 'sporestack[cli]'

Traditional installation

  • Recommended: Create and activate a virtual environment, first.
  • pip install sporestack (Run pip install 'sporestack[cli]' if you wish to use the command line sporestack functionality and not just the Python library.)

Usage Examples

  • Recommended: Make sure you're on the latest stable version comparing sporestack version with git tags in this repository, or releases on PyPI.
  • sporestack token create --dollars 20 --currency xmr
  • sporestack token list
  • sporestack token info
  • sporestack server launch --hostname SomeHostname --operating-system debian-12 --days 1 # Will use ~/.ssh/id_rsa.pub as your SSH key, by default (You may also want to consider passing --region to have a non-random region. This will use the "primary" token by default, which is the default when you run sporestack token create.)
  • sporestack server stop --hostname SomeHostname
  • sporestack server stop --machine-id ss_m_... # Or use --machine-id to be more pedantic.
  • sporestack server start --hostname SomeHostname
  • sporestack server autorenew-enable --hostname SomeHostname
  • sporestack server autorenew-disable --hostname SomeHostname
  • sporestack server list
  • sporestack server delete --hostname SomeHostname

Notes

  • If you want to communicate with the SporeStack API using Tor, set this environment variable: SPORESTACK_USE_TOR_ENDPOINT=1. Verify which endpoint is in use with sporestack api-endpoint.

Developing

  • pipenv install --deploy --dev
  • pipenv run make test
  • pipenv run make format to format files and apply ruff fixes.

Licence

Unlicense/Public domain

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

sporestack-11.1.0.tar.gz (47.3 kB view hashes)

Uploaded Source

Built Distribution

sporestack-11.1.0-py3-none-any.whl (21.7 kB view hashes)

Uploaded Python 3

Supported by

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