| Name | sporestack JSON |
| Version |
14.1.0
JSON |
| download |
| home_page | None |
| Summary | SporeStack API library and CLI for launching servers with Monero or Bitcoin |
| upload_time | 2025-02-09 00:50:13 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | ~=3.9 |
| license | None |
| keywords |
bitcoin
monero
vps
server
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Python 3 library and CLI for [SporeStack](https://sporestack.com) ([SporeStack Tor Hidden Service](http://spore64i5sofqlfz5gq2ju4msgzojjwifls7rok2cti624zyq3fcelad.onion))
[Changelog](CHANGELOG.md)
## Requirements
* Python 3.8-3.11 (and likely newer)
## Running without installing
* Make sure [pipx](https://pipx.pypya.io) is installed.
* `pipx run 'sporestack[cli]'`
## Installation with pipx
* Make sure [pipx](https://pipx.pypya.io) 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](https://pypi.org/project/sporestack/).
* `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](LICENSE.txt)
Raw data
{
"_id": null,
"home_page": null,
"name": "sporestack",
"maintainer": null,
"docs_url": null,
"requires_python": "~=3.9",
"maintainer_email": null,
"keywords": "bitcoin, monero, vps, server",
"author": null,
"author_email": "SporeStack <support@sporestack.com>",
"download_url": "https://files.pythonhosted.org/packages/e0/3d/c3a29da8ad94d844096e68852c76b849cabd42197387e3cbbc3304d855c5/sporestack-14.1.0.tar.gz",
"platform": null,
"description": "# Python 3 library and CLI for [SporeStack](https://sporestack.com) ([SporeStack Tor Hidden Service](http://spore64i5sofqlfz5gq2ju4msgzojjwifls7rok2cti624zyq3fcelad.onion))\n\n[Changelog](CHANGELOG.md)\n\n## Requirements\n\n* Python 3.8-3.11 (and likely newer)\n\n## Running without installing\n\n* Make sure [pipx](https://pipx.pypya.io) is installed.\n* `pipx run 'sporestack[cli]'`\n\n## Installation with pipx\n\n* Make sure [pipx](https://pipx.pypya.io) is installed.\n* `pipx install 'sporestack[cli]'`\n\n## Traditional installation\n\n* Recommended: Create and activate a virtual environment, first.\n* `pip install sporestack` (Run `pip install 'sporestack[cli]'` if you wish to use the command line `sporestack` functionality and not just the Python library.)\n\n## Usage Examples\n\n* Recommended: Make sure you're on the latest stable version comparing `sporestack version` with git tags in this repository, or releases on [PyPI](https://pypi.org/project/sporestack/).\n* `sporestack token create --dollars 20 --currency xmr`\n* `sporestack token list`\n* `sporestack token info`\n* `sporestack server launch --hostname SomeHostname --operating-system debian-12 --days 1 # Will use ~/.ssh/id_rsa.pub as your SSH key, by default`\n(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`.)\n* `sporestack server stop --hostname SomeHostname`\n* `sporestack server stop --machine-id ss_m_... # Or use --machine-id to be more pedantic.`\n* `sporestack server start --hostname SomeHostname`\n* `sporestack server autorenew-enable --hostname SomeHostname`\n* `sporestack server autorenew-disable --hostname SomeHostname`\n* `sporestack server list`\n* `sporestack server delete --hostname SomeHostname`\n\n## Notes\n\n* 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`.\n\n## Developing\n\n* `pipenv install --deploy --dev`\n* `pipenv run make test`\n* `pipenv run make format` to format files and apply ruff fixes.\n\n## Licence\n\n[Unlicense/Public domain](LICENSE.txt)\n\n",
"bugtrack_url": null,
"license": null,
"summary": "SporeStack API library and CLI for launching servers with Monero or Bitcoin",
"version": "14.1.0",
"project_urls": {
"Changelog": "https://git.sporestack.com/SporeStack/sporestack-python/src/branch/master/CHANGELOG.md",
"Homepage": "https://sporestack.com",
"Source": "https://git.sporestack.com/SporeStack/sporestack-python"
},
"split_keywords": [
"bitcoin",
" monero",
" vps",
" server"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "09b754f548fe2d6639824c65883ee4b77daebf8dce489c90bb6f808d7a1dfbdb",
"md5": "687d8027e370e84d8b9a67936e8de233",
"sha256": "61dee87f70c07fb19069ef7f1baec5cccaac6a5ca5b47fac52695d9c842b13cb"
},
"downloads": -1,
"filename": "sporestack-14.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "687d8027e370e84d8b9a67936e8de233",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "~=3.9",
"size": 21536,
"upload_time": "2025-02-09T00:50:12",
"upload_time_iso_8601": "2025-02-09T00:50:12.036673Z",
"url": "https://files.pythonhosted.org/packages/09/b7/54f548fe2d6639824c65883ee4b77daebf8dce489c90bb6f808d7a1dfbdb/sporestack-14.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "e03dc3a29da8ad94d844096e68852c76b849cabd42197387e3cbbc3304d855c5",
"md5": "f4c88ec3fd354f62ae2f1a086e2888ee",
"sha256": "00fc6a2e287571f1f02102c0028ea05a937355bf4688b71264770670185e2f75"
},
"downloads": -1,
"filename": "sporestack-14.1.0.tar.gz",
"has_sig": false,
"md5_digest": "f4c88ec3fd354f62ae2f1a086e2888ee",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "~=3.9",
"size": 52673,
"upload_time": "2025-02-09T00:50:13",
"upload_time_iso_8601": "2025-02-09T00:50:13.974339Z",
"url": "https://files.pythonhosted.org/packages/e0/3d/c3a29da8ad94d844096e68852c76b849cabd42197387e3cbbc3304d855c5/sporestack-14.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-09 00:50:13",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "sporestack"
}
