Skip to main content

ro.py

ro.py is a powerful Python 3 wrapper for the Roblox Web API by @jmkd3v and @iranathan.

ro.py Discord ro.py PyPI ro.py PyPI Downloads ro.py PyPI License ro.py GitHub Commit Activity ro.py GitHub Last Commit

Information | Discord | Requirements | Disclaimer | Documentation | Examples | Credits | License

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.

Update: ro.py on Discord

I’ve set up a small ro.py Discord server. It’s obviously very tiny, but some of you can be the first people to help found the server. If you need support for the library, you can ask your questions here if you need faster support. http://jmk.gg/ro.py

Get Started

To begin, first import the client, which is the most essential part of ro.py, and initialize it like so:

from ro_py import Client
client = Client()

Next, import asyncio at the top of your file:

import asyncio

Next, create an async method main() and run it with asyncio:

async def main():
	# keep this empty for the next step!

asyncio.get_event_loop().run_until_complete(main())

Next, read the documentation for the Client to grab objects and interact with the API.

If you are looking for a full tutorial on ro.py, check out the new DevForum article!

Requirements

  • httpx (for sending requests)
  • iso8601 (for parsing dates)
  • signalrcore (for recieving notifications)
  • lxml (for parsing documentation, might be made optional soon)

Previous Requirements

  • cachecontrol (for caching requests)
  • requests-async (for sending requests, might be updated to a new lib soon)
  • pytweening (for animations, see below)
  • wxPython (for the "prompts" extension, optional)
  • wxasync (see above)

Prompts Extension Requirements

You'll need to install wxPython, wxasync and pytweening to use the prompts extension. If it is not present, an error will be raised.

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 your account may be punished.
If you use code from ro.py in your own library, please credit us! We're working our hardest to deliver this library, and crediting us is the best way to help support the project.

Documentation

You can view documentation for ro.py at 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.

Installation

You can install ro.py from pip:

pip3 install ro.py

If you want the latest bleeding-edge version, clone from git (you'll need git-scm installed):

pip3 install git+git://github.com/rbx-libdev/ro.py.git

Contributors

Other Libraries

ro.py not for you? Come check out these other libraries!

Name Language OOP Async Maintained More Info
ro.py Python 3 Yes Yes Yes You are here!
robloxapi Python 3 Yes Yes No Predecessor to ro.py.
robloxlib Python 3 Yes? No No
pyblox Python 3 Partial No Yes
bloxy Node.JS Yes Yes Yes
noblox.js Node.JS No Yes Yes
roblox.js Node.JS No Yes? No Predecessor to noblox.js.
cblox C++ Yes No? Yes
robloxapi C# Yes Yes Maybe
roblox4j Java Yes No? No
javablox Java Yes No? No
robloxkt Kotlin ? ? No I have no information on this.
KotlinRoblox Kotlin Yes? No? No
rbx.lua Lua N/A No? Yes?
robloxcomm Lua N/A ? ? Again, no info on this or link.
tsblox TypeScript Yes Yes No
roblophp PHP ? ? ? Repo seems to be deleted.

Metadata

Release files for ro-py 1.2.0.5

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ro-py 1.2.0.5
File Size Uploaded Provenance Actions
ro-py-1.2.0.5.tar.gz 43.8 kB Without provenance Details for ro-py-1.2.0.5.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for ro-py 1.2.0.5
File Interpreter ABI Platform Actions
ro_py-1.2.0.5-py3-none-any.whl Python 3 none any Details for ro_py-1.2.0.5-py3-none-any.whl

Total release size: 113.2 kB

Release files / ro-py-1.2.0.5.tar.gz

Download URL ro-py-1.2.0.5.tar.gz
Size 43.8 kB
Tags Source
SHA-256 checksum
How to use checksums
8b5372d34e99ec0831911b63351ec780331510506a6d4ef2cf74e7f546fbd366
BLAKE2b-256 checksum
How to use checksums
8ee2d4bdf59089f9977c81cc64ec57b02257b32a21281cbeeaf6c09884a8ca73
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.3.0 pkginfo/1.7.0 requests/2.24.0 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.9.1

Release files / ro_py-1.2.0.5-py3-none-any.whl

Download URL ro_py-1.2.0.5-py3-none-any.whl
Size 69.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
e382e817ab1c28d1ea2bc72032819258fe6cd6a82af5b6ecf94dfdd0b6d526ef
BLAKE2b-256 checksum
How to use checksums
75475b591d46d2b3ece8295a62dd121438636cb0f30958d31edff52e84361e80
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.3.0 pkginfo/1.7.0 requests/2.24.0 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.9.1

Security for ro-py 1.2.0.5

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

1.2.0.5 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page