SporeStack API library and CLI for launching servers with Monero or Bitcoin
Project description
Python 3 library and CLI for SporeStack .onion
Requirements
- Python 3.8-3.11 (and likely newer)
Installation
pip install sporestack
(Runpip install 'sporestack[cli]'
if you wish to use the CLI features and not just the Python library.)- Recommended: Create a virtual environment, first, and use it inside there.
- Something else to consider: Installing rich (
pip install rich
) in the same virtual environment will make--help
-style output prettier.
Running without installing
- Make sure
pipx
is installed. pipx run 'sporestack[cli]'
- 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 info
sporestack server launch --hostname 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 runsporestack 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
sporestack server remove --hostname 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 havemake
, usealmake
)pipenv run make format
to format files and apply ruff fixes.
Licence
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
sporestack-10.8.0.tar.gz
(48.1 kB
view hashes)
Built Distribution
Close
Hashes for sporestack-10.8.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | bc484d0d5a949c82f8c3512d51a70cb7e6f17c1063a83e3252b642c13ef01944 |
|
MD5 | dfd3af986cf4d3265f59d19ebbf5ed01 |
|
BLAKE2b-256 | 1fcaa78ad1bc0c13c1117e23505aa8583c9493cb5908c594a693a9853d80a0c0 |