Go to file
SporeStack 6bc5791980
ci/woodpecker/push/woodpecker Pipeline failed Details
ci/woodpecker/tag/woodpecker Pipeline failed Details
v11.0.1: Minor bug fixes
2024-02-29 04:31:06 +00:00
src/sporestack v11.0.1: Minor bug fixes 2024-02-29 04:31:06 +00:00
tests v11.0.0 2024-02-27 00:45:32 +00:00
.editorconfig 5.2.1 2022-02-24 23:29:31 +00:00
.gitignore v10.0.0: Cleanups/refactor 2023-04-13 00:01:33 +00:00
.woodpecker.yml v11.0.0 2024-02-27 00:45:32 +00:00
CHANGELOG.md v11.0.1: Minor bug fixes 2024-02-29 04:31:06 +00:00
LICENSE.txt 5.2.1 2022-02-24 23:29:31 +00:00
Makefile Adjustments to .woodpecker.yml 2024-01-18 20:28:39 +00:00
Pipfile v11.0.0 2024-02-27 00:45:32 +00:00
Pipfile.lock v11.0.0 2024-02-27 00:45:32 +00:00
README.md v11.0.0 2024-02-27 00:45:32 +00:00
integration-test.sh v11.0.0 2024-02-27 00:45:32 +00:00
pyproject.toml v11.0.0 2024-02-27 00:45:32 +00:00
tox.ini v11.0.0 2024-02-27 00:45:32 +00:00

README.md

Python 3 library and CLI for SporeStack (SporeStack Tor Hidden Service)

Changelog

Requirements

  • Python 3.8-3.11 (and likely newer)

Running without installing

  • Make sure pipx is installed.
  • pipx run 'sporestack[cli]'

Installation with pipx

  • Make sure pipx is installed.
  • pipx install 'sporestack[cli]'

Traditional installation

  • Recommended: Create and activate a virtual environment, first.
  • pip install sporestack (Run pip install 'sporestack[cli]' if you wish to use the command line sporestack functionality and not just the Python library.)

Usage Examples

  • Recommended: Make sure you're on the latest stable version comparing sporestack version with git tags in this repository, or releases on PyPI.
  • sporestack token create --dollars 20 --currency xmr
  • sporestack token list
  • sporestack token info
  • sporestack server launch --hostname SomeHostname --operating-system debian-12 --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 --hostname SomeHostname
  • sporestack server stop --machine-id ss_m_... # Or use --machine-id to be more pedantic.
  • sporestack server start --hostname SomeHostname
  • sporestack server autorenew-enable --hostname SomeHostname
  • sporestack server autorenew-disable --hostname SomeHostname
  • sporestack server list
  • sporestack server delete --hostname SomeHostname

Notes

  • If you want to communicate with the SporeStack API using Tor, set this environment variable: SPORESTACK_USE_TOR_ENDPOINT=1. Verify which endpoint is in use with sporestack api-endpoint.

Developing

  • pipenv install --deploy --dev
  • pipenv run make test
  • pipenv run make format to format files and apply ruff fixes.

Licence

Unlicense/Public domain