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.
 
 
Teran McKinney 28bee245d7 3.0.1: Use importlib-metadata package on Python 3.7 1 hour ago
src/sporestack 3.0.1: Use importlib-metadata package on Python 3.7 1 hour ago
tests Trim unneeded code 2 hours ago
.coveragerc typer (#2) 3 weeks ago
.flake8 semver V2: Initial commit (now sporestack, not sporestackv2) 4 months ago
.gitignore pytest coverage 2 months ago
LICENSE.txt sporestack-python: 0.1.0 5 years ago
Makefile Remove day validation, add basic typer testing just to start with 2 weeks ago
README.md Update README 1 hour ago
mypy.ini Use new token enable endpoint, pydantic 6 hours ago
pyproject.toml Add isort, requirements-dev.txt 2 months ago
requirements-dev.txt Add isort, requirements-dev.txt 2 months ago
requirements.txt 0.7.1: Fix topup 4 years ago
setup.py 3.0.1: Use importlib-metadata package on Python 3.7 1 hour ago

README.md

Python 3 library and CLI for SporeStack .onion

Requirements

  • Python 3.7+

Installation

  • python3 -m 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.

Upgrade notes for going from v1.4 to v2

  • sporestackv2 was renamed to sporestack.
  • CLI options with _ have been changed to -. So sporestackv2 settlement_token_balance is not sporestack settlement-token-balance. --settlement_tokenis now--settlement-token`.
  • sporestack launch cores/memory/disk removed entirely in favor of flavor.
  • Package is now following semver.
  • Torified instance support has been removed.
  • sporestack launch's --ssh_key_file has been replaced with --ssh-key.
  • WalkingLiberty support was removed. Best to use settlement tokens instead.

Upgrade notes for going from v2 to v3

Library

  • sporestack.version was removed.
  • Now using SporeStackError exceptions with API requests.
  • validate, flavors removed (unneeded here)
  • Settlement token functions have new names, signatures, and responses.
  • Pydantic is now used for settlement token endpoints. (More to come)

CLI

  • flavors command removed (for now)

Screenshot

sporestack CLI screenshot

Usage

  • sporestack launch SomeHostname --flavor vps-1vcpu-1gb --days 7 --ssh-key ~/.ssh/id_rsa.pub --operating-system debian-9 --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-10 --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)

Licence

Unlicense/Public domain