RecNetPy
RecNetPy is a Rec Room API wrapper built in Python. RecNetPy aims to be easy to use yet powerful. It's the same wrapper used to power RecNetBot!
Installation
All platforms via pip:
pip install -U recnetpy
Quickstart
Creating an instance of RecNetPy:
import recnetpy
RecNet = recnetpy.Client(api_key="...")
An example that showcases how to fetch an account by username and acquire its bio:
import recnetpy # Import the module
import asyncio
async def main():
# Create a new RecNetPy client instance
RecNet = recnetpy.Client(api_key="...")
# Fetch the user from the AccountManager with the "get" method
user = await RecNet.accounts.get("ColinXYZ")
# Fetch the bio from the Account dataclass
bio = await user.get_bio()
# Print and close the client
print(bio)
await RecNet.close()
asyncio.run(main())
For more examples and usage, please refer to the examples. More documentation can be found Here.
Authorization
In order to use most of the endpoints, you need an API key. You may acquire one from https://devportal.rec.net/. Endpoints that require an API key are marked in function docstrings.
For more information and guidance, refer to https://recroom.zendesk.com/hc/en-us/articles/16543324225303-Third-Party-API-Access-and-Usage.
Development setup
To install a local build run the following command.
pip install .
Meta
Distributed under the MIT license. See LICENSE for more information.
Contributing
- Fork it (https://github.com/RecNetBot-Development/RecNetPy/fork)
- Create your feature branch (
git checkout -b feature/fooBar) - Commit your changes (
git commit -am 'Add some fooBar') - Push to the branch (
git push origin feature/fooBar) - Create a new Pull Request
Release files for recnetpy 0.2.75
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| recnetpy-0.2.75.tar.gz | 29.8 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| recnetpy-0.2.75-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 76.8 kB
Release files / recnetpy-0.2.75.tar.gz
| Download URL | recnetpy-0.2.75.tar.gz |
|---|---|
| Size | 29.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
9e36bb96ecd37ffa665e299ea37cbfb860c216b508409cb34fa197c1e53daf7b
|
|
BLAKE2b-256 checksum How to use checksums |
f40511a2b1ee7358437e076678b8606a1a6df15fb8ce8d9d9d7705f81adb1de3
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.12.3
|
Release files / recnetpy-0.2.75-py3-none-any.whl
| Download URL | recnetpy-0.2.75-py3-none-any.whl |
|---|---|
| Size | 47.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
c0590d325e73371ee79421e1cfb8d698e8866cbc31d8ab42ae18c3aa11a89c68
|
|
BLAKE2b-256 checksum How to use checksums |
9e083ef2548c3f6ca3ada9b0c4717c35a01567f1e4379d7171e1d2476c0276cf
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.12.3
|
