From ec26024ef05fe797e343fe2833e669d9606573cc Mon Sep 17 00:00:00 2001 From: Sheppsu <49356627+Sheppsu@users.noreply.github.com> Date: Wed, 23 Oct 2024 03:46:03 -0400 Subject: [PATCH] fix readme --- README.rst | 28 ++++++++++++++-------------- setup.py | 3 ++- 2 files changed, 16 insertions(+), 15 deletions(-) diff --git a/README.rst b/README.rst index af7a829..52259fa 100644 --- a/README.rst +++ b/README.rst @@ -1,5 +1,5 @@ osu.py -------- +------ .. image:: https://discordapp.com/api/guilds/836755328493420614/widget.png?style=shield :target: https://discord.gg/Z2J6SSRPcE @@ -18,7 +18,7 @@ Easy to use API wrapper for osu!api v2 written in Python. Has a high-level interface while still allowing ways to do more complex things. Major features/capabilities --------------------------- +--------------------------- - Compatible with Python 3.8+ - Client class which carries out all api requests - AsynchronousClient class for asynchronous requests (install with async feature) @@ -45,27 +45,27 @@ Installation # Installing straight from github (downloads latest code, which is not guaranteed to be stable) py -m pip install git+https://github.com/Sheepposu/osu.py.git - - # Install with asynchronous client + + # Install with asynchronous client py -m pip install -U osu.py[async] # Install with all features - py -m pip install -U osu.py[async,replay,notifications] - - # Install from github with features - git clone https://github.com/sheppsu/osu.py - cd osu.py - py -m pip install -U .[async,replay,notifications] + py -m pip install -U osu.py[async,replay,notifications] + + # Install from github with features + git clone https://github.com/sheppsu/osu.py + cd osu.py + py -m pip install -U .[async,replay,notifications] Example ------- .. code:: py - from osu import Client, GameModeStr + from osu import Client, GameModeStr - client = Client.from_client_credentials(0, "*****", None) - user = client.get_user(14895608, GameModeStr.STANDARD) - print(user) + client = Client.from_client_credentials(0, "*****", None) + user = client.get_user(14895608, GameModeStr.STANDARD) + print(user) Links ----- diff --git a/setup.py b/setup.py index 9fbc804..fbfcb13 100644 --- a/setup.py +++ b/setup.py @@ -49,12 +49,13 @@ ] setuptools.setup( - name="osu.py", + name="osu.pytest", version=version, packages=packages, author="Sheepposu", description="API Wrapper for osu!api v2 written in Python.", long_description=readme, + long_description_content_type="text/x-rst", install_requires=requirements, extras_require=extra_require, project_urls=project_urls,