You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+9-4Lines changed: 9 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,5 @@
1
1
# RecNetPy
2
-
> **RecNetPy** is an API wrapper built in Python for pulling data from [RecNet](https://rec.net/). **RecNetPy** aims to be easy to use yet powerful. It's the same wrapper used to power [RecNetBot](https://github.com/RecNetBot-Development/RecNetBot)!.
2
+
> **RecNetPy** is an API wrapper built in Python for pulling data from [RecNet](https://rec.net/). **RecNetPy** aims to be easy to use yet powerful. It's the same wrapper used to power [RecNetBot](https://github.com/RecNetBot-Development/RecNetBot)!
3
3
4
4
[![NPM Version][pip-image]][pip-url]
5
5
[![Downloads Stats][pip-downloads]][pip-url]
@@ -20,7 +20,7 @@ Creating an instance of RecNetPy:
20
20
```py
21
21
import recnetpy
22
22
23
-
RecNet = recnetpy.Client()
23
+
RecNet = recnetpy.Client(api_key="...")
24
24
```
25
25
26
26
An example that showcases how to fetch an account by username and acquire its bio:
@@ -30,7 +30,7 @@ import asyncio
30
30
31
31
asyncdefmain():
32
32
# Create a new RecNetPy client instance
33
-
RecNet = recnetpy.Client()
33
+
RecNet = recnetpy.Client(api_key="...")
34
34
35
35
# Fetch the user from the AccountManager with the "get" method
36
36
user =await RecNet.accounts.get("ColinXYZ")
@@ -47,6 +47,11 @@ asyncio.run(main())
47
47
48
48
_For more examples and usage, please refer to the [``examples``][examples-url]. More documentation can be found [Here][documentation]._
49
49
50
+
## Authorization
51
+
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.
52
+
53
+
For more information and guidance, refer to https://recroom.zendesk.com/hc/en-us/articles/16543324225303-Third-Party-API-Access-and-Usage.
54
+
50
55
## Development setup
51
56
52
57
To install a local build run the following command.
@@ -79,4 +84,4 @@ _Distributed under the MIT license. See [``LICENSE``][license] for more informat
0 commit comments