PloudosAPI
An API Wrapper to interact with ploudos.com
With PloudosAPI, you can start and stop your PloudOS servers, get the server console, run commands and do lots of other stuff.
Install the package
To install the package, run the command pip install PloudosAPI.
Get started
Log in to your PloudOS account:
import PloudosAPI
session = PloudosAPI.login("username", "password") #replace with your PloudOS username / password
Get a PloudOS server by its id:
server = session.get_server("server_id")
… or by its name:
servers = session.get_servers_with_name("name")
server = servers[0]
Start the server:
server.start()
Get the server console and execute commands: (Only works when the server is running)
console = server.get_console()
server.post_to_console("command") #replace with the command you want to run
Stop the PloudOS server:
server.stop()
Get your PloudOS servers:
my_servers = session.servers()
session.servers() returns a dict with your PloudOS servers that looks like this:
{
"owned" : [
PloudosAPI.PloudosServer,
PloudosAPI.PloudosServer,
...
],
"shared" : [
PloudosAPI.PloudosServer,
PloudosAPI.PloudosServer,
...
]
}
Other stuff
Force a server shutdown:
server.force_stop()
Regenerate the server’s world:
server.regenerate_world(*, seed="your_seed", hardcore=False)
Share the server with a PloudOS user:
server.share_add("user")
Remove the access of a PloudOS user:
server.share_remove("user")
Ban / Unban a minecraft player from the server:
server.ban("player")
server.unban("player")
Metadata
Release files for PloudosAPI 0.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| PloudosAPI-0.1.0.tar.gz | 4.7 kB | Without provenance | Details for PloudosAPI-0.1.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| PloudosAPI-0.1.0-py3-none-any.whl | Python 3 | none | any | Details for PloudosAPI-0.1.0-py3-none-any.whl |
Total release size: 11.7 kB
Release files / PloudosAPI-0.1.0.tar.gz
| Download URL | PloudosAPI-0.1.0.tar.gz |
|---|---|
| Size | 4.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
f89ca4f0989fa42a591a8179fcb6bfa1253f282b50be9066abd72835b3dbb126
|
|
BLAKE2b-256 checksum How to use checksums |
d1e356f69cceb529f6773449660301a417589d3e6f25f07dbb713b365032a064
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.11.4
|
Release files / PloudosAPI-0.1.0-py3-none-any.whl
| Download URL | PloudosAPI-0.1.0-py3-none-any.whl |
|---|---|
| Size | 7.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
3f162464d2779c948d70c4be082e8a25e6f6e99f3b4a213e190aba8741c6e7ed
|
|
BLAKE2b-256 checksum How to use checksums |
8a5ca9c923abd067d06d908de34b37cf17468bdff141c407499ec8f1e4eb9c71
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.11.4
|
Security for PloudosAPI 0.1.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.