ossapi
======

ossapi is the definitive python wrapper for osu! `api v2 <https://osu.ppy.sh/docs/index.html>`__ and `api v1 <https://github.com/ppy/osu-api/wiki>`__.

ossapi is developed and maintained by `tybug <https://github.com/tybug>`__.

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

ossapi can be installed from pip:

.. code-block:: console

    $ pip install ossapi

Links
-----

| Github: https://github.com/tybug/ossapi
| Documentation: https://tybug.github.io/ossapi/
| Discord: https://discord.gg/VNnkTjm

Pages
-----

Check out :doc:`Creating a Client <creating-a-client>` for a quickstart, or :doc:`Endpoints <endpoints>` for documentation of all endpoints.

.. toctree::
   :maxdepth: 2

   self
   quickstart
   advanced
   endpoints
   api-reference