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 1bd1231a20 Merge pull request 'Use pre-commit' (#7) from pre-commit into master 6 days ago
src/sporestack Use pre-commit 6 days ago
tests Add pdoc, replace make.py with Makefile (#6) 1 month ago
.editorconfig Consolidate configuration, get rid of asaman 1 month ago
.gitignore pytest coverage 6 months ago
.pre-commit-config.yaml Fix pre-commit config 6 days ago
.woodpecker.yml Pull pre-commit out of Pipfile 6 days ago
LICENSE.txt sporestack-python: 0.1.0 5 years ago
Makefile Pull pre-commit out of Pipfile 6 days ago
Pipfile Pull pre-commit out of Pipfile 6 days ago
Pipfile.lock Pull pre-commit out of Pipfile 6 days ago
README.md Pull pre-commit out of Pipfile 6 days ago
pyproject.toml Consolidate configuration, get rid of asaman 1 month ago
setup.cfg Use pre-commit 6 days 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