Skip to content

Commit

Permalink
fix readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Sheppsu committed Oct 23, 2024
1 parent 660f0b2 commit ec26024
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 15 deletions.
28 changes: 14 additions & 14 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
osu.py
-------
------

.. image:: https://discordapp.com/api/guilds/836755328493420614/widget.png?style=shield
:target: https://discord.gg/Z2J6SSRPcE
Expand All @@ -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)
Expand All @@ -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
-----
Expand Down
3 changes: 2 additions & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down

0 comments on commit ec26024

Please sign in to comment.