Browse Source

Update README

master 3.0.0
Teran McKinney 4 weeks ago
parent
commit
f258c34432
  1. 23
      README.md

23
README.md

@ -1,14 +1,19 @@
# Python 3 library and CLI for [SporeStack](https://sporestack.com) [.onion](http://spore64i5sofqlfz5gq2ju4msgzojjwifls7rok2cti624zyq3fcelad.onion)
## Requirements
* Python 3.7+
## Installation
* `python3 -m pip install sporestack`
* Optional: Create a virtual environment, first.
* Recommended: Create a virtual environment, first. Can use `pipenv`, as well.
## Running without installing
## Running without installing (preferred)
* Make sure `pipx` is installed.
* `pipx run sporestack`
* Make sure you're on the latest version with `sporestack version`.
## Upgrade notes for going from v1.4 to v2
@ -20,6 +25,20 @@
* `sporestack launch`'s `--ssh_key_file` has been replaced with `--ssh-key`.
* WalkingLiberty support was removed. Best to use settlement tokens instead.
## Upgrade notes for going from v2 to v3
### Library
* sporestack.__version__ was removed.
* Now using SporeStackError exceptions with API requests.
* validate, flavors removed (unneeded here)
* Settlement token functions have new names, signatures, and responses.
* Pydantic is now used for settlement token endpoints. (More to come)
### CLI
* flavors command removed (for now)
## Screenshot
![sporestack CLI screenshot](https://sporestack.com/static/sporestackv2-screenshot.png)

Loading…
Cancel
Save