- 
-## Information
-Welcome, and thank you for using ro.py!
-ro.py is an object oriented, asynchronous wrapper for the Roblox Web API (and other Roblox-related APIs) with many new and interesting features.
-ro.py allows you to automate much of what you would do on the Roblox website and on other Roblox-related websites.
+## Overview
+ro.py is an asynchronous, object-oriented wrapper for the Roblox web API.
-## Requirements
-- httpx (for sending requests)
-- iso8601 (for parsing dates)
-- signalrcore (for recieving notifications)
-- ~~cachecontrol (for caching requests)~~
-- ~~requests-async (for sending requests, might be updated to a new lib soon)~~
-- pytweening (for UI animations for the "prompts" extension, optional)
-- wxPython (for the "prompts" extension, optional)
-- wxasync (see above)
-
-## Disclaimer
-We are not responsible for any malicious use of this library.
-If you use this library in a way that violates the [Roblox Terms of Use](https://en.help.roblox.com/hc/en-us/articles/115004647846-Roblox-Terms-of-Use) your account may be punished.
-
-## Documentation
-You can view documentation for ro.py at [ro.py.jmksite.dev](https://ro.py.jmksite.dev/).
-If something's missing from docs, feel free to dive into the code and read the docstrings as most things are documented there.
-The docs are generated from docstrings in the code using pdoc3.
+## Features
+- **Asynchronous**: ro.py works well with asynchronous frameworks like [FastAPI](https://fastapi.tiangolo.com/) and
+[discord.py](https://github.com/Rapptz/discord.py).
+- **Easy**: ro.py's client-based model is intuitive and easy to learn.
+ It abstracts away API requests and leaves you with simple objects that represent data on the Roblox platform.
+- **Flexible**: ro.py's Requests object allows you to extend ro.py beyond what we've already implemented.
## Installation
-You can install ro.py from pip:
+To install the latest stable version of ro.py, run the following command:
```
-pip install ro-py
+python3 -m pip install roblox
```
-If you want the latest bleeding-edge version, clone from git:
+
+To install the latest **unstable** version of ro.py, install [git-scm](https://git-scm.com/downloads) and run the following:
```
-pip install git+git://github.com/rbx-libdev/ro.py.git
+python3 -m pip install git+https://github.com/ro-py/ro.py.git
```
-Known issue: wxPython sometimes has trouble building on certain devices. I put wxPython last on the requirements so Python attempts to install it last, so you can safely ignore this error as everything else should be installed.
-
-## Credits
-[@iranathan](https://github.com/iranathan) - maintainer
-[@jmkdev](https://github.com/iranathan) - maintainer
-[@nsg-mfd](https://github.com/nsg-mfd) - helped with endpoints
-## Other Libraries
-ro.py not for you? Come check out these other libraries!
-Name | Language | OOP | Async | Maintained | More Info |
-------------------------------------------------------------|------------|---------|-------|------------|---------------------------------|
-[ro.py](https://github.com/rbx-libdev/ro.py) | Python 3 | Yes | Yes | Yes | You are here! |
-[robloxapi](https://github.com/iranathan/robloxapi) | Python 3 | Yes | Yes | No | Predecessor to ro.py. |
-[robloxlib](https://github.com/NoahCristino/robloxlib) | Python 3 | Yes? | No | No | |
-[pyblox](https://github.com/RbxAPI/Pyblox) | Python 3 | Partial | No | Yes | |
-[bloxy](https://github.com/Visualizememe/bloxy) | Node.JS | Yes | Yes | Yes | |
-[noblox.js](https://github.com/suufi/noblox.js) | Node.JS | No | Yes | Yes | |
-[roblox.js](https://github.com/sentanos/roblox-js) | Node.JS | No | Yes? | No | Predecessor to noblox.js. |
-[cblox](https://github.com/Meqolo/cblox) | C++ | Yes | No? | Yes | |
-[robloxapi](https://github.com/gamenew09/RobloxAPI) | C# | Yes | Yes | Maybe | |
-[roblox4j](https://github.com/PizzaCrust/Roblox4j) | Java | Yes | No? | No | |
-[javablox](https://github.com/RbxAPI/Javablox) | Java | Yes | No? | No | |
-robloxkt | Kotlin | ? | ? | No | I have no information on this. |
-[KotlinRoblox](https://github.com/PizzaCrust/KotlinRoblox) | Kotlin | Yes? | No? | No | |
-[rbx.lua](https://github.com/iiToxicity/rbx.lua) | Lua | N/A | No? | Yes? | |
-robloxcomm | Lua | N/A | ? | ? | Again, no info on this or link. |
-[tsblox](https://github.com/Dionysusnu/TSBlox) | TypeScript | Yes | Yes | No | |
-roblophp | PHP | ? | ? | ? | Repo seems to be deleted. |
+## Support
+- Learn how to use ro.py in the docs: https://ro.py.jmk.gg/dev/tutorials/
+- The [RoAPI Discord server](https://discord.gg/a69neqaNZ5) provides support for ro.py in the `#ro.py-support` channel.
diff --git a/docs/CNAME b/docs/CNAME
deleted file mode 100644
index 6deca327..00000000
--- a/docs/CNAME
+++ /dev/null
@@ -1 +0,0 @@
-ro.py.jmksite.dev
diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md
new file mode 100644
index 00000000..1702bd16
--- /dev/null
+++ b/docs/SUMMARY.md
@@ -0,0 +1,15 @@
+---
+search:
+ exclude: true
+---
+
+* [Overview](index.md)
+* [Tutorials](tutorials/index.md)
+ * [Get Started](tutorials/get-started.md)
+ * [Authentication](tutorials/authentication.md)
+ * [Error Handling](tutorials/error-handling.md)
+ * [Thumbnails](tutorials/thumbnails.md)
+ * [Pagination](tutorials/pagination.md)
+ * [ROBLOSECURITY](tutorials/roblosecurity.md)
+ * [Bases](tutorials/bases.md)
+* [Code Reference](reference/)
\ No newline at end of file
diff --git a/docs/accountinformation.html b/docs/accountinformation.html
deleted file mode 100644
index cbb23870..00000000
--- a/docs/accountinformation.html
+++ /dev/null
@@ -1,621 +0,0 @@
-
-
-
-
-
-
-Module ro_py.accountinformation
-This file houses functions and classes that pertain to Roblox authenticated user account information.
-
-
--Expand source code -
-"""
-
-This file houses functions and classes that pertain to Roblox authenticated user account information.
-
-"""
-
-from datetime import datetime
-from ro_py.gender import RobloxGender
-
-endpoint = "https://accountinformation.roblox.com/"
-
-
-class AccountInformationMetadata:
- """
- Represents account information metadata.
- """
- def __init__(self, metadata_raw):
- self.is_allowed_notifications_endpoint_disabled = metadata_raw["isAllowedNotificationsEndpointDisabled"]
- """Unsure what this does."""
- self.is_account_settings_policy_enabled = metadata_raw["isAccountSettingsPolicyEnabled"]
- """Whether the account settings policy is enabled (unsure exactly what this does)"""
- self.is_phone_number_enabled = metadata_raw["isPhoneNumberEnabled"]
- """Whether the user's linked phone number is enabled."""
- self.max_user_description_length = metadata_raw["MaxUserDescriptionLength"]
- """Maximum length of the user's description."""
- self.is_user_description_enabled = metadata_raw["isUserDescriptionEnabled"]
- """Whether the user's description is enabled."""
- self.is_user_block_endpoints_updated = metadata_raw["isUserBlockEndpointsUpdated"]
- """Whether the UserBlock endpoints are updated (unsure exactly what this does)"""
-
-
-class PromotionChannels:
- """
- Represents account information promotion channels.
- """
- def __init__(self, promotion_raw):
- self.promotion_channels_visibility_privacy = promotion_raw["promotionChannelsVisibilityPrivacy"]
- """Visibility of promotion channels."""
- self.facebook = promotion_raw["facebook"]
- """Link to the user's Facebook page."""
- self.twitter = promotion_raw["twitter"]
- """Link to the user's Twitter page."""
- self.youtube = promotion_raw["youtube"]
- """Link to the user's YouTube page."""
- self.twitch = promotion_raw["twitch"]
- """Link to the user's Twitch page."""
-
-
-class AccountInformation:
- """
- Represents authenticated client account information (https://accountinformation.roblox.com/)
- This is only available for authenticated clients as it cannot be accessed otherwise.
-
- Parameters
- ----------
- requests : ro_py.utilities.requests.Requests
- Requests object to use for API requests.
- """
- def __init__(self, requests):
- self.requests = requests
- self.account_information_metadata = None
- self.promotion_channels = None
-
- async def update(self):
- """
- Updates the account information.
- """
- account_information_req = await self.requests.get(
- url="https://accountinformation.roblox.com/v1/metadata"
- )
- self.account_information_metadata = AccountInformationMetadata(account_information_req.json())
- promotion_channels_req = await self.requests.get(
- url="https://accountinformation.roblox.com/v1/promotion-channels"
- )
- self.promotion_channels = PromotionChannels(promotion_channels_req.json())
-
- async def get_gender(self):
- """
- Gets the user's gender.
-
- Returns
- -------
- ro_py.gender.RobloxGender
- """
- gender_req = await self.requests.get(endpoint + "v1/gender")
- return RobloxGender(gender_req.json()["gender"])
-
- async def set_gender(self, gender):
- """
- Sets the user's gender.
-
- Parameters
- ----------
- gender : ro_py.gender.RobloxGender
- """
- await self.requests.post(
- url=endpoint + "v1/gender",
- data={
- "gender": str(gender.value)
- }
- )
-
- async def get_birthdate(self):
- """
- Grabs the user's birthdate.
-
- Returns
- -------
- datetime.datetime
- """
- birthdate_req = await self.requests.get(endpoint + "v1/birthdate")
- birthdate_raw = birthdate_req.json()
- birthdate = datetime(
- year=birthdate_raw["birthYear"],
- month=birthdate_raw["birthMonth"],
- day=birthdate_raw["birthDay"]
- )
- return birthdate
-
- async def set_birthdate(self, birthdate):
- """
- Sets the user's birthdate.
-
- Parameters
- ----------
- birthdate : datetime.datetime
- """
- await self.requests.post(
- url=endpoint + "v1/birthdate",
- data={
- "birthMonth": birthdate.month,
- "birthDay": birthdate.day,
- "birthYear": birthdate.year
- }
- )Classes
--
-
-class AccountInformation -(requests) -
--
--
Represents authenticated client account information (https://accountinformation.roblox.com/) -This is only available for authenticated clients as it cannot be accessed otherwise.
-Parameters
--
-
requests:Requests
-- Requests object to use for API requests. -
---Expand source code -
-
-class AccountInformation: - """ - Represents authenticated client account information (https://accountinformation.roblox.com/) - This is only available for authenticated clients as it cannot be accessed otherwise. - - Parameters - ---------- - requests : ro_py.utilities.requests.Requests - Requests object to use for API requests. - """ - def __init__(self, requests): - self.requests = requests - self.account_information_metadata = None - self.promotion_channels = None - - async def update(self): - """ - Updates the account information. - """ - account_information_req = await self.requests.get( - url="https://accountinformation.roblox.com/v1/metadata" - ) - self.account_information_metadata = AccountInformationMetadata(account_information_req.json()) - promotion_channels_req = await self.requests.get( - url="https://accountinformation.roblox.com/v1/promotion-channels" - ) - self.promotion_channels = PromotionChannels(promotion_channels_req.json()) - - async def get_gender(self): - """ - Gets the user's gender. - - Returns - ------- - ro_py.gender.RobloxGender - """ - gender_req = await self.requests.get(endpoint + "v1/gender") - return RobloxGender(gender_req.json()["gender"]) - - async def set_gender(self, gender): - """ - Sets the user's gender. - - Parameters - ---------- - gender : ro_py.gender.RobloxGender - """ - await self.requests.post( - url=endpoint + "v1/gender", - data={ - "gender": str(gender.value) - } - ) - - async def get_birthdate(self): - """ - Grabs the user's birthdate. - - Returns - ------- - datetime.datetime - """ - birthdate_req = await self.requests.get(endpoint + "v1/birthdate") - birthdate_raw = birthdate_req.json() - birthdate = datetime( - year=birthdate_raw["birthYear"], - month=birthdate_raw["birthMonth"], - day=birthdate_raw["birthDay"] - ) - return birthdate - - async def set_birthdate(self, birthdate): - """ - Sets the user's birthdate. - - Parameters - ---------- - birthdate : datetime.datetime - """ - await self.requests.post( - url=endpoint + "v1/birthdate", - data={ - "birthMonth": birthdate.month, - "birthDay": birthdate.day, - "birthYear": birthdate.year - } - )Methods
--
-
-async def get_birthdate(self) -
--
--
Grabs the user's birthdate.
-Returns
--
-
datetime.datetime
-- -
---Expand source code -
-
-async def get_birthdate(self): - """ - Grabs the user's birthdate. - - Returns - ------- - datetime.datetime - """ - birthdate_req = await self.requests.get(endpoint + "v1/birthdate") - birthdate_raw = birthdate_req.json() - birthdate = datetime( - year=birthdate_raw["birthYear"], - month=birthdate_raw["birthMonth"], - day=birthdate_raw["birthDay"] - ) - return birthdate
- -async def get_gender(self) -
--
-
---
-Expand source code -
-
-async def get_gender(self): - """ - Gets the user's gender. - - Returns - ------- - ro_py.gender.RobloxGender - """ - gender_req = await self.requests.get(endpoint + "v1/gender") - return RobloxGender(gender_req.json()["gender"])
- -async def set_birthdate(self, birthdate) -
--
--
Sets the user's birthdate.
-Parameters
--
-
birthdate:datetime.datetime
-- -
---Expand source code -
-
-async def set_birthdate(self, birthdate): - """ - Sets the user's birthdate. - - Parameters - ---------- - birthdate : datetime.datetime - """ - await self.requests.post( - url=endpoint + "v1/birthdate", - data={ - "birthMonth": birthdate.month, - "birthDay": birthdate.day, - "birthYear": birthdate.year - } - )
- -async def set_gender(self, gender) -
--
-
---
-Expand source code -
-
-async def set_gender(self, gender): - """ - Sets the user's gender. - - Parameters - ---------- - gender : ro_py.gender.RobloxGender - """ - await self.requests.post( - url=endpoint + "v1/gender", - data={ - "gender": str(gender.value) - } - )
- -async def update(self) -
--
--
Updates the account information.
---Expand source code -
-
-async def update(self): - """ - Updates the account information. - """ - account_information_req = await self.requests.get( - url="https://accountinformation.roblox.com/v1/metadata" - ) - self.account_information_metadata = AccountInformationMetadata(account_information_req.json()) - promotion_channels_req = await self.requests.get( - url="https://accountinformation.roblox.com/v1/promotion-channels" - ) - self.promotion_channels = PromotionChannels(promotion_channels_req.json())
-
- -class AccountInformationMetadata -(metadata_raw) -
--
--
Represents account information metadata.
---Expand source code -
-
-class AccountInformationMetadata: - """ - Represents account information metadata. - """ - def __init__(self, metadata_raw): - self.is_allowed_notifications_endpoint_disabled = metadata_raw["isAllowedNotificationsEndpointDisabled"] - """Unsure what this does.""" - self.is_account_settings_policy_enabled = metadata_raw["isAccountSettingsPolicyEnabled"] - """Whether the account settings policy is enabled (unsure exactly what this does)""" - self.is_phone_number_enabled = metadata_raw["isPhoneNumberEnabled"] - """Whether the user's linked phone number is enabled.""" - self.max_user_description_length = metadata_raw["MaxUserDescriptionLength"] - """Maximum length of the user's description.""" - self.is_user_description_enabled = metadata_raw["isUserDescriptionEnabled"] - """Whether the user's description is enabled.""" - self.is_user_block_endpoints_updated = metadata_raw["isUserBlockEndpointsUpdated"] - """Whether the UserBlock endpoints are updated (unsure exactly what this does)"""Instance variables
--
-
var is_account_settings_policy_enabled
--
--
Whether the account settings policy is enabled (unsure exactly what this does)
- var is_allowed_notifications_endpoint_disabled
--
--
Unsure what this does.
- var is_phone_number_enabled
--
--
Whether the user's linked phone number is enabled.
- var is_user_block_endpoints_updated
--
--
Whether the UserBlock endpoints are updated (unsure exactly what this does)
- var is_user_description_enabled
--
--
Whether the user's description is enabled.
- var max_user_description_length
--
--
Maximum length of the user's description.
-
- -class PromotionChannels -(promotion_raw) -
--
--
Represents account information promotion channels.
---Expand source code -
-
-class PromotionChannels: - """ - Represents account information promotion channels. - """ - def __init__(self, promotion_raw): - self.promotion_channels_visibility_privacy = promotion_raw["promotionChannelsVisibilityPrivacy"] - """Visibility of promotion channels.""" - self.facebook = promotion_raw["facebook"] - """Link to the user's Facebook page.""" - self.twitter = promotion_raw["twitter"] - """Link to the user's Twitter page.""" - self.youtube = promotion_raw["youtube"] - """Link to the user's YouTube page.""" - self.twitch = promotion_raw["twitch"] - """Link to the user's Twitch page."""Instance variables
--
-
var facebook
--
--
Link to the user's Facebook page.
- var promotion_channels_visibility_privacy
--
--
Visibility of promotion channels.
- var twitch
--
--
Link to the user's Twitch page.
- var twitter
--
--
Link to the user's Twitter page.
- var youtube
--
--
Link to the user's YouTube page.
-
-
+ 
+