forked from vrchatapi/vrchatapi-python
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathsetup.py
More file actions
167 lines (120 loc) · 6.51 KB
/
setup.py
File metadata and controls
167 lines (120 loc) · 6.51 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
"""
VRChat API Documentation
# VRChat API Library for Python
A Python client to interact with the unofficial VRChat API. Supports all REST calls specified in the [API specification](https://github.com/vrchatapi/specification).
## Disclaimer
This is the official response of the VRChat Team (from Tupper more specifically) on the usage of the VRChat API.
> Use of the API using applications other than the approved methods (website, VRChat application) are not officially supported. You may use the API for your own application, but keep these guidelines in mind:
> * We do not provide documentation or support for the API.
> * Do not make queries to the API more than once per 60 seconds.
> * Abuse of the API may result in account termination.
> * Access to API endpoints may break at any given time, with no warning.
As stated, this documentation was not created with the help of the official VRChat team. Therefore this documentation is not an official documentation of the VRChat API and may not be always up to date with the latest versions. If you find that a page or endpoint is not longer valid please create an issue and tell us so we can fix it.
## Getting Started
First add the package to to your project:
```bash
pip install vrchatapi
```
Below is an example on how to login to the API and fetch your own user information.
```python
# Step 1. We begin with creating a Configuration, which contains the username and password for authentication.
import vrchatapi
from vrchatapi.api import authentication_api, users_api
configuration = vrchatapi.Configuration(
username = 'username',
password = 'password',
)
# Step 2. VRChat consists of several API's (WorldsApi, UsersApi, FilesApi, NotificationsApi, FriendsApi, etc...)
# Here we enter a context of the API Client and instantiate the Authentication API which is required for logging in.
# Enter a context with an instance of the API client
with vrchatapi.ApiClient(configuration) as api_client:
# Instantiate instances of API classes
auth_api = authentication_api.AuthenticationApi(api_client)
try:
# Step 3. Calling getCurrentUser on Authentication API logs you in if the user isn't already logged in.
current_user = auth_api.get_current_user()
print("Logged in as:", current_user.display_name)
except vrchatapi.ApiException as e:
print("Exception when calling API: %s\n", e)
```
See [example.py](https://github.com/vrchatapi/vrchatapi-python/blob/main/example.py) for more example usage on getting started.
## Contributing
Contributions are welcome, but do not add features that should be handled by the OpenAPI specification.
Join the [Discord server](https://discord.gg/Ge2APMhPfD) to get in touch with us.
The version of the OpenAPI document: 1.6.5
Contact: [email protected]
Generated by: https://openapi-generator.tech
"""
from setuptools import setup, find_packages # noqa: H301
NAME = "vrchatapi"
VERSION = "1.6.5"
# To install the library, run the following
#
# python setup.py install
#
# prerequisite: setuptools
# http://pypi.python.org/pypi/setuptools
REQUIRES = [
"urllib3 >= 1.25.3",
"python-dateutil",
]
setup(
name=NAME,
version=VERSION,
description="VRChat API Library for Python",
author="Unofficial VRChat API Documentation Project",
url="",
keywords=["vrchat", "vrchatapi", "vrc"],
python_requires=">=3.6",
install_requires=REQUIRES,
packages=find_packages(exclude=["test", "tests"]),
include_package_data=True,
license="The MIT License (MIT)",
long_description_content_type="text/markdown",
long_description="""\
# VRChat API Library for Python
A Python client to interact with the unofficial VRChat API. Supports all REST calls specified in the [API specification](https://github.com/vrchatapi/specification).
## Disclaimer
This is the official response of the VRChat Team (from Tupper more specifically) on the usage of the VRChat API.
> Use of the API using applications other than the approved methods (website, VRChat application) are not officially supported. You may use the API for your own application, but keep these guidelines in mind:
> * We do not provide documentation or support for the API.
> * Do not make queries to the API more than once per 60 seconds.
> * Abuse of the API may result in account termination.
> * Access to API endpoints may break at any given time, with no warning.
As stated, this documentation was not created with the help of the official VRChat team. Therefore this documentation is not an official documentation of the VRChat API and may not be always up to date with the latest versions. If you find that a page or endpoint is not longer valid please create an issue and tell us so we can fix it.
## Getting Started
First add the package to to your project:
```bash
pip install vrchatapi
```
Below is an example on how to login to the API and fetch your own user information.
```python
# Step 1. We begin with creating a Configuration, which contains the username and password for authentication.
import vrchatapi
from vrchatapi.api import authentication_api, users_api
configuration = vrchatapi.Configuration(
username = 'username',
password = 'password',
)
# Step 2. VRChat consists of several API's (WorldsApi, UsersApi, FilesApi, NotificationsApi, FriendsApi, etc...)
# Here we enter a context of the API Client and instantiate the Authentication API which is required for logging in.
# Enter a context with an instance of the API client
with vrchatapi.ApiClient(configuration) as api_client:
# Instantiate instances of API classes
auth_api = authentication_api.AuthenticationApi(api_client)
try:
# Step 3. Calling getCurrentUser on Authentication API logs you in if the user isn't already logged in.
current_user = auth_api.get_current_user()
print("Logged in as:", current_user.display_name)
except vrchatapi.ApiException as e:
print("Exception when calling API: %s\n", e)
```
See [example.py](https://github.com/vrchatapi/vrchatapi-python/blob/main/example.py) for more example usage on getting started.
## Contributing
Contributions are welcome, but do not add features that should be handled by the OpenAPI specification.
Join the [Discord server](https://discord.gg/Ge2APMhPfD) to get in touch with us.
"""
)