An open API service indexing awesome lists of open source software.

https://github.com/top-gg-community/python-sdk

A simple API wrapper for top.gg written in Python
https://github.com/top-gg-community/python-sdk

bot botlist dbl discord discordbotlist discordbots

Last synced: 28 days ago
JSON representation

A simple API wrapper for top.gg written in Python

Awesome Lists containing this project

README

          

#####################
Top.gg Python Library
#####################

.. image:: https://img.shields.io/pypi/v/topggpy.svg
:target: https://pypi.python.org/pypi/topggpy
:alt: View on PyPi
.. image:: https://img.shields.io/pypi/pyversions/topggpy.svg
:target: https://pypi.python.org/pypi/topggpy
:alt: v1.0.0
.. image:: https://readthedocs.org/projects/topggpy/badge/?version=latest
:target: https://topggpy.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status

A simple API wrapper for `Top.gg `_ written in Python, supporting discord.py.

Installation
------------

Install via pip (recommended)

.. code:: bash

pip3 install topggpy

Install from source

.. code:: bash

pip3 install git+https://github.com/top-gg/python-sdk/

Documentation
-------------

Documentation can be found `here `_

Features
--------

* POST server count
* GET bot info, server count, upvote info
* GET all bots
* GET user info
* GET widgets (large and small) including custom ones. See `docs.top.gg `_ for more info.
* GET weekend status
* Built-in webhook to handle Top.gg votes
* Automated server count posting
* Searching for bots via the API

Additional information
----------------------

* Before using the webhook provided by this library, make sure that you have specified port open.
* Optimal values for port are between 1024 and 49151.
* If you happen to need help implementing topggpy in your bot, feel free to ask in the ``#development`` or ``#api`` channels in our `Discord server `_.

Examples
--------

For examples, follow the link `here `__