Python 3 library and CLI application for SporeStack
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
SporeStack c8f0a1cd52 Put servers into ~/.sporestack/servers instead of ~/.sporestack 5 months ago
src/sporestack Put servers into ~/.sporestack/servers instead of ~/.sporestack 5 months ago
tests 5.2.1 6 months ago
.editorconfig 5.2.1 6 months ago
.gitignore 5.2.1 6 months ago
.pre-commit-config.yaml 5.2.1 6 months ago
.woodpecker.yml 5.2.1 6 months ago
CHANGELOG.md 5.2.1 6 months ago
LICENSE.txt 5.2.1 6 months ago
Makefile 5.2.1 6 months ago
Pipfile Put servers into ~/.sporestack/servers instead of ~/.sporestack 5 months ago
Pipfile.lock Put servers into ~/.sporestack/servers instead of ~/.sporestack 5 months ago
README.md 5.2.1 6 months ago
pyproject.toml 5.2.1 6 months ago
setup.cfg 5.2.2: Improve `sporestack list` expired server handling 6 months ago

README.md

Python 3 library and CLI for SporeStack .onion

Requirements

  • Python 3.7-3.10 (or maybe newer)

Installation

  • pip install sporestack
  • Recommended: Create a virtual environment, first. Can use pipenv, as well.

Running without installing (preferred)

  • Make sure pipx is installed.
  • pipx run sporestack
  • Make sure you're on the latest version with sporestack version.

Screenshot

sporestack CLI screenshot

Usage

  • sporestack launch SomeHostname --flavor vps-1vcpu-1gb --days 7 --ssh-key ~/.ssh/id_rsa.pub --operating-system debian-10 --currency btc
  • sporestack topup SomeHostname --days 3 --currency xmr
  • sporestack launch SomeOtherHostname --flavor vps-1vcpu-2gb --days 7 --ssh-key ~/.ssh/id_rsa.pub --operating-system debian-11 --currency btc
  • sporestack stop SomeHostname
  • sporestack start SomeHostname
  • sporestack list
  • sporestack remove SomeHostname # If expired
  • sporestack settlement-token-generate
  • sporestack settlement-token-enable (token) --dollars 10 --currency xmr
  • sporestack settlement-token-add (token) --dollars 25 --currency btc
  • sporestack settlement-token-balance (token)

More examples on the website.

Notes

  • You can use --settlement-token if you don't want to pay with QR codes all the time.
  • If using a .onion API endpoint, will try to use a local Tor proxy if connecting to a .onion URL. (127.0.0.1:9050)

Developing

  • pip install pipenv pre-commit
  • pipenv install --deploy --dev
  • pipenv run make test (If you don't have make, use almake)
  • Hint: pre-commit run is a faster way to run some of the tests/autofixers.

Licence

Unlicense/Public domain