# multicraft
[](https://pypi.org/project/multicraft/)
[](https://www.python.org/downloads/)
[](https://github.com/legopitstop/multicraft-py/issues)
Interact with your Minecraft server from hosts that use [Multicraft](https://www.multicraft.org/) using Python.
## Installation
Install the module with pip:
```bat
pip3 install multicraft
```
Update existing installation: `pip3 install multicraft --upgrade`
## Features
- Includes a handful of common multicraft hosts.
- Manage users, players, commands, schedules, and databases.
- Start, stop, or restart your server.
- Run console commands (give, kill, whitelist, op, etc)
- Read your servers current cpu and memmory usage.
- Send a chat message.
See the [docs](https://github.com/legopitstop/multicraft-py/wiki) for more information.
## Dependencies
|Name|Description|
|--|--|
|[requests](https://pypi.org/project/requests/) | Requests is a simple, yet elegant, HTTP library. |
## Example
```py
from multicraft import MulticraftAPI
api = MulticraftAPI(
url = 'https://localhost/api.php',
user = 'username',
key = 'apiKey'
)
owner = api.get_user_id(api.user)
owned_servers = api.list_servers_by_owner(owner)
print(owned_servers)
for id in owned_servers.keys():
server = api.get_server(id)
print(server)
```
Raw data
{
"_id": null,
"home_page": "https://github.com/legopitstop/multicraft-py",
"name": "multicraft",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": "",
"keywords": "multicraft,minecraft,minecraftserver,server",
"author": "Legopitstop",
"author_email": "officiallegopitstop@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/b4/9d/93cfcef9c6022a8c7c72bb509a09a12d86fea86f41339e7dfacdb7a33eb2/multicraft-0.0.2.tar.gz",
"platform": null,
"description": "# multicraft\r\n\r\n[](https://pypi.org/project/multicraft/)\r\n[](https://www.python.org/downloads/)\r\n\r\n\r\n[](https://github.com/legopitstop/multicraft-py/issues)\r\n\r\nInteract with your Minecraft server from hosts that use [Multicraft](https://www.multicraft.org/) using Python.\r\n\r\n## Installation\r\nInstall the module with pip:\r\n```bat\r\npip3 install multicraft\r\n```\r\nUpdate existing installation: `pip3 install multicraft --upgrade`\r\n\r\n## Features\r\n- Includes a handful of common multicraft hosts.\r\n- Manage users, players, commands, schedules, and databases.\r\n- Start, stop, or restart your server.\r\n- Run console commands (give, kill, whitelist, op, etc)\r\n- Read your servers current cpu and memmory usage.\r\n- Send a chat message.\r\n\r\nSee the [docs](https://github.com/legopitstop/multicraft-py/wiki) for more information.\r\n\r\n## Dependencies\r\n|Name|Description|\r\n|--|--|\r\n|[requests](https://pypi.org/project/requests/) | Requests is a simple, yet elegant, HTTP library. |\r\n\r\n## Example\r\n```py\r\nfrom multicraft import MulticraftAPI\r\n\r\napi = MulticraftAPI(\r\n url = 'https://localhost/api.php',\r\n user = 'username',\r\n key = 'apiKey'\r\n)\r\n\r\nowner = api.get_user_id(api.user)\r\n\r\nowned_servers = api.list_servers_by_owner(owner)\r\nprint(owned_servers)\r\n\r\nfor id in owned_servers.keys():\r\n server = api.get_server(id)\r\n print(server)\r\n```\r\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Interact with your Minecraft server from hosts that use Multicraft using Python",
"version": "0.0.2",
"project_urls": {
"Homepage": "https://github.com/legopitstop/multicraft-py"
},
"split_keywords": [
"multicraft",
"minecraft",
"minecraftserver",
"server"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b49d93cfcef9c6022a8c7c72bb509a09a12d86fea86f41339e7dfacdb7a33eb2",
"md5": "06256354c267c015d90cd8eaaac54b7e",
"sha256": "7b9f79d85836dcbb45937a76e8efa110e89cff790aad2b909b23ae42835befb8"
},
"downloads": -1,
"filename": "multicraft-0.0.2.tar.gz",
"has_sig": false,
"md5_digest": "06256354c267c015d90cd8eaaac54b7e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 13176,
"upload_time": "2023-12-14T04:36:42",
"upload_time_iso_8601": "2023-12-14T04:36:42.108119Z",
"url": "https://files.pythonhosted.org/packages/b4/9d/93cfcef9c6022a8c7c72bb509a09a12d86fea86f41339e7dfacdb7a33eb2/multicraft-0.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-14 04:36:42",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "legopitstop",
"github_project": "multicraft-py",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "multicraft"
}
JSON
