Skip to main content

A Geometry Dash API wrapper for Python

Project description

Project License Build Status PyPI Library Version Required Python Versions Project Development Status Library Downloads/Week Documentation Status Code Quality [Codacy] Code Coverage Patreon Page [Support]

gd.py is a library that provides its users ability to interact with servers of Geometry Dash.

Key Features

  • Modern Pythonic API

  • High coverage of the supported Geometry Dash API

  • Using async and await syntax

Installing

Python 3.5.3 or higher is required

To install the library, you can just run the following command:

# Linux/OS X
python3 -m pip install -U gd.py

# Windows
py -3 -m pip install -U gd.py

You can also install optional aioconsole package, which can be used to run async functions in repl:

# Linux/OS X
python3 -m pip install -U gd.py[console]

# Windows
py -3 -m pip install -U gd.py[console]

gd.py also provides an optional Cython extension to speed up its parser functions in gd.api folder, so make sure that you have Cython and C++ Build Tools installed.

To install the developer version, run these commands:

$ git clone https://github.com/NeKitDS/gd.py
$ cd gd.py
$ python3 -m pip install -U .[dev]

Quick example

Below is an example of fetching a song by its ID.

import gd

client = gd.Client()

async def test():
    song = await client.get_song(633206)
    print(song.name)

client.run(test())

# OUTPUT: Random Song 01

You can find more examples in examples directory.

Credits

Thanks to Alex1304 for inspiring the creation of this library.

Credits to Rapptz and discord.py library developers; tasks package in discord.py is a base for tasks.py file.

Authors

This project is mainly developed by NeKitDS, with help of blue. Big thanks to cos8o and SMJS for helping to make several requests. Also thanks to cos8o again for developing GDCrypto library, which was used as a base for crypto package.

Project details


Download files

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

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distributions

gd.py-0.10.4-py3.8.egg (294.3 kB view hashes)

Uploaded Source

gd.py-0.10.4-py3.8-win-amd64.egg (473.9 kB view hashes)

Uploaded Source

Supported by

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