recnetpy 0.2.1

RecNetPy is an API wrapper built in Python for pulling data from RecNet.

RecNetPy

RecNetPy is an API wrapper built in Python for pulling data from RecNet. 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

1. Fork it (https://github.com/RecNetBot-Development/RecNetPy/fork)
2. Create your feature branch (git checkout -b feature/fooBar)
3. Commit your changes (git commit -am 'Add some fooBar')
4. Push to the branch (git push origin feature/fooBar)
5. Create a new Pull Request