Go to file
SporeStack 5728118ec1
ci/woodpecker/push/woodpecker Pipeline is pending Details
Fix pre-commit in Woodpecker
2022-11-02 00:04:13 +00:00
src/sporestack v7.2.1: Fix on Python 3.7 and 3.8 2022-11-02 00:00:00 +00:00
tests v7.2.0: Use new format for new tokens 2022-11-01 23:25: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
.pre-commit-config.yaml v7.2.0: Use new format for new tokens 2022-11-01 23:25:24 +00:00
.woodpecker.yml Fix pre-commit in Woodpecker 2022-11-02 00:04:13 +00:00
CHANGELOG.md v7.2.1: Fix on Python 3.7 and 3.8 2022-11-02 00:00:00 +00:00
LICENSE.txt 5.2.1 2022-02-24 23:29:31 +00:00
Makefile 6.0.2: Switch from setuptools to flit 2022-04-22 01:10:34 +00:00
Pipfile Put servers into ~/.sporestack/servers instead of ~/.sporestack 2022-03-30 22:55:59 +00:00
Pipfile.lock v7.2.1: Fix on Python 3.7 and 3.8 2022-11-02 00:00:00 +00:00
README.md 6.0.0: Major release! See the changelog for details 2022-04-14 01:44:54 +00:00
pyproject.toml 6.0.2: Switch from setuptools to flit 2022-04-22 01:10:34 +00:00

README.md

Python 3 library and CLI for SporeStack .onion

Changelog

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