# PteroDark
## Language
- [English](README.md)
- [Русский](READMERU.md)
- [Українська](READMEUK.md)
## WARNING: the library is under development and may not work as described below
PteroDark is a Python library that serves as an API wrapper for the Pterodactyl panel. It provides an easy and convenient way to interact with the Pterodactyl API and manage your game servers.
## ~~Features~~
- ~~Authenticate and manage API tokens~~
- ~~Get information about servers, users, and nodes~~
- ~~Create, update, and delete servers~~
- ~~Start, stop, restart, and reinstall servers~~
- ~~Manage server files and directories~~
- ~~Execute commands on servers~~
- ~~And much more!~~
## Installation
To install PteroDark, simply use pip:
```bash
pip install PteroDark
```
## ~~Usage~~
~~Here's a simple example of how to use PteroDark to interact with the Pterodactyl API:~~
```python
import PteroDark
# Create a client instance
client = PteroDark.Client(api_url='https://your-panel-url.com', api_key='your-api-key')
# Get information about a server
server_info = client.get_server_info(server_id='your-server-id')
print(server_info)
# Start the server
client.start_server(server_id='your-server-id')
# Execute a command on the server
output = client.send_command(server_id='your-server-id', command='say Hello, server!')
print(output)
```
~~For more detailed documentation and examples, please refer to the [official PteroDark documentation](https://github.com/LeaveHosting/PteroDark).~~
## Contributions
Contributions to PteroDark are always welcome! If you have any suggestions, bug reports, or feature requests, please open an issue or submit a pull request on the [GitHub repository](https://github.com/LeaveHosting/PteroDark).
## License
PteroDark is licensed under the MIT License. See the [LICENSE](https://github.com/LeaveHosting/PteroDark/blob/main/LICENSE) file for more information.
## Acknowledgements
Special thanks to the Pterodactyl team for providing the amazing panel and API that inspired this library.
Feel free to reach out if you have any questions or need further assistance. Happy coding with PteroDark!
Raw data
{
"_id": null,
"home_page": "https://github.com/LeaveHosting/PteroDark",
"name": "PteroDark",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": "",
"keywords": "example python",
"author": "LeaveHosting",
"author_email": "leavehosting@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/31/8d/0f4f10f4d7939f565cde24d32315743606b594824d78792d84da33bf0cab/PteroDark-1.0.0.tar.gz",
"platform": null,
"description": "# PteroDark\n\n## Language\n- [English](README.md)\n- [\u0420\u0443\u0441\u0441\u043a\u0438\u0439](READMERU.md)\n- [\u0423\u043a\u0440\u0430\u0457\u043d\u0441\u044c\u043a\u0430](READMEUK.md)\n\n## WARNING: the library is under development and may not work as described below\n\nPteroDark is a Python library that serves as an API wrapper for the Pterodactyl panel. It provides an easy and convenient way to interact with the Pterodactyl API and manage your game servers.\n\n## ~~Features~~\n\n- ~~Authenticate and manage API tokens~~\n- ~~Get information about servers, users, and nodes~~\n- ~~Create, update, and delete servers~~\n- ~~Start, stop, restart, and reinstall servers~~\n- ~~Manage server files and directories~~\n- ~~Execute commands on servers~~\n- ~~And much more!~~\n\n## Installation\n\nTo install PteroDark, simply use pip:\n\n```bash\npip install PteroDark\n```\n\n## ~~Usage~~\n\n~~Here's a simple example of how to use PteroDark to interact with the Pterodactyl API:~~\n\n```python\nimport PteroDark\n\n# Create a client instance\nclient = PteroDark.Client(api_url='https://your-panel-url.com', api_key='your-api-key')\n\n# Get information about a server\nserver_info = client.get_server_info(server_id='your-server-id')\nprint(server_info)\n\n# Start the server\nclient.start_server(server_id='your-server-id')\n\n# Execute a command on the server\noutput = client.send_command(server_id='your-server-id', command='say Hello, server!')\nprint(output)\n```\n\n~~For more detailed documentation and examples, please refer to the [official PteroDark documentation](https://github.com/LeaveHosting/PteroDark).~~\n\n## Contributions\n\nContributions to PteroDark are always welcome! If you have any suggestions, bug reports, or feature requests, please open an issue or submit a pull request on the [GitHub repository](https://github.com/LeaveHosting/PteroDark).\n\n## License\n\nPteroDark is licensed under the MIT License. See the [LICENSE](https://github.com/LeaveHosting/PteroDark/blob/main/LICENSE) file for more information.\n\n## Acknowledgements\n\nSpecial thanks to the Pterodactyl team for providing the amazing panel and API that inspired this library.\n\nFeel free to reach out if you have any questions or need further assistance. Happy coding with PteroDark!\n",
"bugtrack_url": null,
"license": "",
"summary": "Pterodactyl API wrapper",
"version": "1.0.0",
"project_urls": {
"Documentation": "https://github.com/LeaveHosting/PteroDark/README.md",
"Homepage": "https://github.com/LeaveHosting/PteroDark"
},
"split_keywords": [
"example",
"python"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b3f898bb0b0b009ae52108930ed335ff5dd54de82dc0d159699dcea4fcfc0743",
"md5": "8ed987f233cdbcea67e488fb838bae7f",
"sha256": "f984c77e436b19abe437135038b1ab69a9fa1703c3725cc508c29d6b0e833a71"
},
"downloads": -1,
"filename": "PteroDark-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8ed987f233cdbcea67e488fb838bae7f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 3377,
"upload_time": "2023-08-06T20:56:17",
"upload_time_iso_8601": "2023-08-06T20:56:17.288927Z",
"url": "https://files.pythonhosted.org/packages/b3/f8/98bb0b0b009ae52108930ed335ff5dd54de82dc0d159699dcea4fcfc0743/PteroDark-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "318d0f4f10f4d7939f565cde24d32315743606b594824d78792d84da33bf0cab",
"md5": "572eeb26354b7ace2428f067c1de142f",
"sha256": "358ba5075f255c453168b695ca8060e997d1c66fcd21f6253894667a3c2e6768"
},
"downloads": -1,
"filename": "PteroDark-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "572eeb26354b7ace2428f067c1de142f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 3132,
"upload_time": "2023-08-06T20:56:19",
"upload_time_iso_8601": "2023-08-06T20:56:19.192349Z",
"url": "https://files.pythonhosted.org/packages/31/8d/0f4f10f4d7939f565cde24d32315743606b594824d78792d84da33bf0cab/PteroDark-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-06 20:56:19",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "LeaveHosting",
"github_project": "PteroDark",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "pterodark"
}
JSON
