Go to file
SporeStack b4705c3634 Add token messages support 2023-03-15 04:06:30 +00:00
src/sporestack Add token messages support 2023-03-15 04:06:30 +00:00
tests v9.0.0: Use httpx, /server/quote support, Client support 2023-02-08 21:06:24 +00:00
.editorconfig 5.2.1 2022-02-24 23:29:31 +00:00
.gitignore 5.2.1 2022-02-24 23:29:31 +00:00
.woodpecker.yml Attempt CI fix 2022-11-28 16:49:50 +00:00
CHANGELOG.md Add token messages support 2023-03-15 04:06:30 +00:00
LICENSE.txt 5.2.1 2022-02-24 23:29:31 +00:00
Makefile v9.0.0: Use httpx, /server/quote support, Client support 2023-02-08 21:06:24 +00:00
Pipfile Progress + replace pre-commit with black+ruff 2023-02-07 18:22:20 +00:00
Pipfile.lock v9.0.0: Use httpx, /server/quote support, Client support 2023-02-08 21:06:24 +00:00
README.md README improvements 2023-02-07 19:42:49 +00:00
pyproject.toml v9.0.0: Use httpx, /server/quote support, Client support 2023-02-08 21:06:24 +00:00

README.md

Python 3 library and CLI for SporeStack .onion

Changelog

Requirements

  • Python 3.7-3.11 (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

  • pipenv install --deploy --dev
  • pipenv run make test (If you don't have make, use almake)
  • pipenv run make format to format files and apply ruff fixes.

Licence

Unlicense/Public domain