rbxapi / pyblox Goto Github PK

An API wrapper for Roblox written in Python. (Maintained)

License: MIT License

Python 100.00%

api-wrapper roblox python python3 library roblox-lua robloxdev roblox-api wrapper

pyblox's Introduction

An API wrapper for Roblox written in Python.

The purpose of this API wrapper is to expose Roblox's API for third party use and/or for individual standalone projects. This is the first stable Python API wrapper for the Roblox API. Documentation can be found within each module. I encourage developers to look into the codebase to better understand this wrapper and what it can truly offer.

This branch is incredibly unstable but will replace master once it's stable enough for full release. This is intended to be v3.x.x and beyond. Please be aware that there are breaking changes in design and will not be compatible w/ any versions prior.

If you would like to contribute, create a pull request with the changes you made. If you have a complaint, issue or problem, create an issue and I will try to answer as fast as I can.

Notice: Traditional documentation does not exist due to the fact that developers should know what the code does and why it could benefit your project. Please take a look at the library's files for references. In almost all cases, you'll find that the class names match up with the documentation found in the following format: https://APINAME.roblox.com/#docs

Requirements

Python 3.8+ / 3.8-dev+ or PyPy3
asyncio
httpx
pytest

Notice: Requirements should be installed automatically via pip.

Feature Addition

Supports an unlimited amount of users
Supports an unlimited amount of groups
Supports authentication by cookie
Supports wide coverage of the API
Follows the official documentation that Roblox provides
Handles token-managment for you

Notice: This does not cover all that Pyblox has to offer just a subset.

Compatibility

Async Compatible (default)
Supports MacOS, Windows, Linux, Raspbian
Should be able to work on PyPy3
Will not work on Python 2.x.x or any version below Python 3.8
Works with Discord.py & other Python-based discord libraries
Only works via cookie login; does not support username and password authentication

Disclaimer: When using any of the authentication features, please do not risk your account. Instead, use an alt or a secondary account to protect your main account and assets that belong to it.

pyblox's People

Contributors

Stargazers

Watchers

Forkers

iranathan omg12345f bray821 hayden-droid cristiano100 dohmboyog emzy-code tomodachi94 guberm theprocut goldfish-boi

pyblox's Issues

[Question] Finding UserId

Is there a good way to get the UserId for further use? For example Friends.friendList(randomid,1)

How do I iterate through the groupList?

groups = pyblox3.Groups.groupList(myuseridgoeshere) does return a list of my groups, but iterating through it gives me what seems like a bunch of unrelated numbers and it seems like a strange type of JSON thing. I just want to get a single group out of it and check my role in that group.

pyblox module not getting referenced

Hey, I am fairly new to python (started yesterday lol ). Sorry if this is too basic.

I tried installing pyblox3 by the manual method and pip method both, also tried uninstalling and installing again and restarting my IDE. I have python 3+ version and PyCharm as the IDE. It still says "pyblox3 module doesnt exist"

What am I doing wrong?

this is the pyblox3 folder in Python>Lib>Site-Packages> pyblox3

Revert 'Master' to 'Legacy'

Error handling

Hi, I think instead of using print to show that a request failed the lib should raise an error.
Although the person is able to detect if the function worked by checking if it returned None or not there program is unable to get the reason without there being a human looking at the console.

If the lib would throw an error the program would be able to get why it failed with try/except statements, witch would be useful if someone is using the lib for public projects so they can display the error to the user.

response = await Groups_v1.Wall.post(groupid=4658962,body="Async Test 1")
if not response:
   print("failed")

from pyblox import RequestError

try:
   await Groups_v1.Wall.post(groupid=4658962,body="Async Test 1")
except RequestError as message:
   print("Failed", message")

Thanks, Ira.

Refresh cookie endpoint

For context: https://github.com/RbxAPI/Pyblox/blob/nightly_build/pyblox3/src/util/req.py#L69

I really don't think this is necessary, It will just respond with an error because your not sending an xcsrf token. Thats why I think your cookie did not refresh. Further the endpoint being used (if it succeeds) will refresh the cookie and send a new one in the response cookies.

Thanks, Ira.

Groups.grouplist(userid) is returning None

So i'm coding a discord bot and I want it to display the names of all the groups a roblox user is in, however when I do the groupList function, it returns none. Here is my code:

    groups = pyblox3.Groups.groupList(userid)
    print(groups)

The response i get:
None
ERROR:root:[Pyblox][GET] Something went wrong. Error: 404

[Feature Request] Group Payout Support

Groups - getUserRole no longer functions.

Using getUserRole on the master branch no longer works. I get an HTTP Error 410 (gone). Attempting to visit the link tells me it was removed.

https://www.roblox.com/Game/LuaWebService/HandleSocialRequest.ashx?method=GetGroupRole&playerid=113754334&groupId=3017674

ERROR:root:[Pyblox][GET] Something went wrong. Error: 410
None