Skip to main content

Pterodactyl API wrapper

Project description

PteroDark

Language

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:

pip install PteroDark

Usage

Here's a simple example of how to use PteroDark to interact with the Pterodactyl API:

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.

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.

License

PteroDark is licensed under the MIT License. See the 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!

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

PteroDark-1.0.0.tar.gz (3.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

PteroDark-1.0.0-py3-none-any.whl (3.4 kB view details)

Uploaded Python 3

File details

Details for the file PteroDark-1.0.0.tar.gz.

File metadata

  • Download URL: PteroDark-1.0.0.tar.gz
  • Upload date:
  • Size: 3.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.3

File hashes

Hashes for PteroDark-1.0.0.tar.gz
Algorithm Hash digest
SHA256 358ba5075f255c453168b695ca8060e997d1c66fcd21f6253894667a3c2e6768
MD5 572eeb26354b7ace2428f067c1de142f
BLAKE2b-256 318d0f4f10f4d7939f565cde24d32315743606b594824d78792d84da33bf0cab

See more details on using hashes here.

File details

Details for the file PteroDark-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: PteroDark-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 3.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.3

File hashes

Hashes for PteroDark-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f984c77e436b19abe437135038b1ab69a9fa1703c3725cc508c29d6b0e833a71
MD5 8ed987f233cdbcea67e488fb838bae7f
BLAKE2b-256 b3f898bb0b0b009ae52108930ed335ff5dd54de82dc0d159699dcea4fcfc0743

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page