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 2af37624f7 6.0.0a1: Token-centric release 3 months ago
src/sporestack 6.0.0a1: Token-centric release 3 months ago
tests 5.2.1 4 months ago
.editorconfig 5.2.1 4 months ago
.gitignore 5.2.1 4 months ago
.pre-commit-config.yaml 5.2.1 4 months ago
.woodpecker.yml 6.0.0a1: Token-centric release 3 months ago
CHANGELOG.md 6.0.0a1: Token-centric release 3 months ago
LICENSE.txt 5.2.1 4 months ago
Makefile 6.0.0a1: Token-centric release 3 months ago
Pipfile Put servers into ~/.sporestack/servers instead of ~/.sporestack 3 months ago
Pipfile.lock Put servers into ~/.sporestack/servers instead of ~/.sporestack 3 months ago
README.md 6.0.0a1: Token-centric release 3 months ago
pyproject.toml 5.2.1 4 months ago
setup.cfg 6.0.0a1: Token-centric release 3 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, and use it inside there.

Running without installing

  • Make sure pipx is installed.
  • pipx run sporestack
  • Make sure you're on the latest stable version comparing sporestack version with git tags in this repository, or releases on PyPI.

Usage

  • sporestack token create --dollars 20 --currency xmr # Can use btc as well.
  • sporestack token list
  • sporestack token balance
  • sporestack server launch SomeHostname --operating-system debian-11 --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 SomeHostname
  • sporestack server start SomeHostname
  • sporestack server list
  • sporestack server remove SomeHostname # If expired

Notes

  • If you want to communicate with SporeStack APIs using Tor, set this environment variable: SPORESTACK_USE_TOR_ENDPOINT=1

Developing

  • pip install pipenv pre-commit
  • pre-commit install
  • pipenv install --deploy --dev
  • pipenv run make test (If you don't have make, use almake)
  • pre-commit run --all-files (To format code, or wait for git commit)

Licence

Unlicense/Public domain