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.
spore ca26d95ba9 Use Alpine for Python 3.10 image 3 days ago
src/sporestack Add pep8-naming 1 week ago
tests 5.1.0: Add TOR_PROXY environment variable to configure SOCKS proxy selection 2 months ago
.coveragerc typer (#2) 3 months ago
.flake8 Test on Python 3.7, 3.9, and 3.10. Replace Makefile with make.py (#4) 4 days ago
.gitignore pytest coverage 5 months ago
.woodpecker.yml Use Alpine for Python 3.10 image 3 days ago
LICENSE.txt sporestack-python: 0.1.0 5 years ago
Pipfile Test on Python 3.7, 3.9, and 3.10. Replace Makefile with make.py (#4) 4 days ago
Pipfile.lock Use Alpine for Python 3.10 image 3 days ago
README.md Test on Python 3.7, 3.9, and 3.10. Replace Makefile with make.py (#4) 4 days ago
make.py Test on Python 3.7, 3.9, and 3.10. Replace Makefile with make.py (#4) 4 days ago
mypy.ini 5.1.2 1 week ago
pyproject.toml Replace setup.py with setup.cfg, remove affiliate stuff from CLI 2 weeks ago
setup.cfg 5.1.2 1 week ago

README.md

Python 3 library and CLI for SporeStack .onion

Requirements

  • Python 3.7+, preferably 3.8+

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