chickenstats-api 0.0.1__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- chickenstats_api-0.0.1/PKG-INFO +199 -0
- chickenstats_api-0.0.1/README.md +181 -0
- chickenstats_api-0.0.1/chickenstats_api/__init__.py +104 -0
- chickenstats_api-0.0.1/chickenstats_api/api/__init__.py +13 -0
- chickenstats_api-0.0.1/chickenstats_api/api/chicken_nhl_api.py +3895 -0
- chickenstats_api-0.0.1/chickenstats_api/api/game_stats_api.py +1072 -0
- chickenstats_api-0.0.1/chickenstats_api/api/lines_api.py +878 -0
- chickenstats_api-0.0.1/chickenstats_api/api/login_api.py +1444 -0
- chickenstats_api-0.0.1/chickenstats_api/api/play_by_play_api.py +1303 -0
- chickenstats_api-0.0.1/chickenstats_api/api/season_stats_api.py +480 -0
- chickenstats_api-0.0.1/chickenstats_api/api/stats_api.py +1514 -0
- chickenstats_api-0.0.1/chickenstats_api/api/team_stats_api.py +312 -0
- chickenstats_api-0.0.1/chickenstats_api/api/users_api.py +2471 -0
- chickenstats_api-0.0.1/chickenstats_api/api_client.py +802 -0
- chickenstats_api-0.0.1/chickenstats_api/api_response.py +21 -0
- chickenstats_api-0.0.1/chickenstats_api/configuration.py +582 -0
- chickenstats_api-0.0.1/chickenstats_api/exceptions.py +217 -0
- chickenstats_api-0.0.1/chickenstats_api/models/__init__.py +37 -0
- chickenstats_api-0.0.1/chickenstats_api/models/http_validation_error.py +96 -0
- chickenstats_api-0.0.1/chickenstats_api/models/lines_create.py +380 -0
- chickenstats_api-0.0.1/chickenstats_api/models/lines_public.py +378 -0
- chickenstats_api-0.0.1/chickenstats_api/models/message.py +88 -0
- chickenstats_api-0.0.1/chickenstats_api/models/new_password.py +91 -0
- chickenstats_api-0.0.1/chickenstats_api/models/pbp_public.py +1138 -0
- chickenstats_api-0.0.1/chickenstats_api/models/stats_create.py +488 -0
- chickenstats_api-0.0.1/chickenstats_api/models/stats_game.py +486 -0
- chickenstats_api-0.0.1/chickenstats_api/models/stats_season.py +496 -0
- chickenstats_api-0.0.1/chickenstats_api/models/team_stats_create.py +254 -0
- chickenstats_api-0.0.1/chickenstats_api/models/team_stats_public.py +252 -0
- chickenstats_api-0.0.1/chickenstats_api/models/token.py +90 -0
- chickenstats_api-0.0.1/chickenstats_api/models/update_password.py +91 -0
- chickenstats_api-0.0.1/chickenstats_api/models/user_create.py +102 -0
- chickenstats_api-0.0.1/chickenstats_api/models/user_public.py +102 -0
- chickenstats_api-0.0.1/chickenstats_api/models/user_update.py +112 -0
- chickenstats_api-0.0.1/chickenstats_api/models/user_update_me.py +101 -0
- chickenstats_api-0.0.1/chickenstats_api/models/users_public.py +98 -0
- chickenstats_api-0.0.1/chickenstats_api/models/validation_error.py +100 -0
- chickenstats_api-0.0.1/chickenstats_api/models/validation_error_loc_inner.py +139 -0
- chickenstats_api-0.0.1/chickenstats_api/py.typed +0 -0
- chickenstats_api-0.0.1/chickenstats_api/rest.py +259 -0
- chickenstats_api-0.0.1/chickenstats_api.egg-info/PKG-INFO +199 -0
- chickenstats_api-0.0.1/chickenstats_api.egg-info/SOURCES.txt +76 -0
- chickenstats_api-0.0.1/chickenstats_api.egg-info/dependency_links.txt +1 -0
- chickenstats_api-0.0.1/chickenstats_api.egg-info/requires.txt +4 -0
- chickenstats_api-0.0.1/chickenstats_api.egg-info/top_level.txt +1 -0
- chickenstats_api-0.0.1/pyproject.toml +95 -0
- chickenstats_api-0.0.1/setup.cfg +7 -0
- chickenstats_api-0.0.1/setup.py +51 -0
- chickenstats_api-0.0.1/test/test_chicken_nhl_api.py +116 -0
- chickenstats_api-0.0.1/test/test_game_stats_api.py +53 -0
- chickenstats_api-0.0.1/test/test_http_validation_error.py +59 -0
- chickenstats_api-0.0.1/test/test_lines_api.py +53 -0
- chickenstats_api-0.0.1/test/test_lines_create.py +150 -0
- chickenstats_api-0.0.1/test/test_lines_public.py +148 -0
- chickenstats_api-0.0.1/test/test_login_api.py +67 -0
- chickenstats_api-0.0.1/test/test_message.py +53 -0
- chickenstats_api-0.0.1/test/test_new_password.py +55 -0
- chickenstats_api-0.0.1/test/test_pbp_public.py +270 -0
- chickenstats_api-0.0.1/test/test_play_by_play_api.py +60 -0
- chickenstats_api-0.0.1/test/test_season_stats_api.py +39 -0
- chickenstats_api-0.0.1/test/test_stats_api.py +60 -0
- chickenstats_api-0.0.1/test/test_stats_create.py +208 -0
- chickenstats_api-0.0.1/test/test_stats_game.py +206 -0
- chickenstats_api-0.0.1/test/test_stats_season.py +204 -0
- chickenstats_api-0.0.1/test/test_team_stats_api.py +39 -0
- chickenstats_api-0.0.1/test/test_team_stats_create.py +132 -0
- chickenstats_api-0.0.1/test/test_team_stats_public.py +130 -0
- chickenstats_api-0.0.1/test/test_token.py +54 -0
- chickenstats_api-0.0.1/test/test_update_password.py +55 -0
- chickenstats_api-0.0.1/test/test_user_create.py +58 -0
- chickenstats_api-0.0.1/test/test_user_public.py +58 -0
- chickenstats_api-0.0.1/test/test_user_update.py +56 -0
- chickenstats_api-0.0.1/test/test_user_update_me.py +53 -0
- chickenstats_api-0.0.1/test/test_users_api.py +95 -0
- chickenstats_api-0.0.1/test/test_users_public.py +69 -0
- chickenstats_api-0.0.1/test/test_validation_error.py +61 -0
- chickenstats_api-0.0.1/test/test_validation_error_loc_inner.py +51 -0
|
@@ -0,0 +1,199 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: chickenstats_api
|
|
3
|
+
Version: 0.0.1
|
|
4
|
+
Summary: chickenstats API
|
|
5
|
+
Home-page:
|
|
6
|
+
Author: chicken
|
|
7
|
+
Author-email: chicken <chicken@chickenandstats.com>
|
|
8
|
+
License-Expression: MIT
|
|
9
|
+
Project-URL: Repository, https://github.com/chickenandstats/chickenstats-api-python
|
|
10
|
+
Keywords: OpenAPI,OpenAPI-Generator,chickenstats API
|
|
11
|
+
Requires-Python: >=3.9
|
|
12
|
+
Description-Content-Type: text/markdown
|
|
13
|
+
Requires-Dist: urllib3<3.0.0,>=2.1.0
|
|
14
|
+
Requires-Dist: python-dateutil>=2.8.2
|
|
15
|
+
Requires-Dist: pydantic>=2
|
|
16
|
+
Requires-Dist: typing-extensions>=4.7.1
|
|
17
|
+
Dynamic: author
|
|
18
|
+
|
|
19
|
+
# chickenstats-api
|
|
20
|
+
API for downloading NHL data
|
|
21
|
+
|
|
22
|
+
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
|
23
|
+
|
|
24
|
+
- API version: 0.1.0
|
|
25
|
+
- Package version: 0.0.1
|
|
26
|
+
- Generator version: 7.14.0
|
|
27
|
+
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
|
|
28
|
+
For more information, please visit [https://api.chickenstats.com/](https://api.chickenstats.com/)
|
|
29
|
+
|
|
30
|
+
## Requirements.
|
|
31
|
+
|
|
32
|
+
Python 3.9+
|
|
33
|
+
|
|
34
|
+
## Installation & Usage
|
|
35
|
+
### pip install
|
|
36
|
+
|
|
37
|
+
If the python package is hosted on a repository, you can install directly using:
|
|
38
|
+
|
|
39
|
+
```sh
|
|
40
|
+
pip install git+https://github.com/chickenandstats/chickenstats-api-python.git
|
|
41
|
+
```
|
|
42
|
+
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/chickenandstats/chickenstats-api-python.git`)
|
|
43
|
+
|
|
44
|
+
Then import the package:
|
|
45
|
+
```python
|
|
46
|
+
import chickenstats_api
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
### Setuptools
|
|
50
|
+
|
|
51
|
+
Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
|
|
52
|
+
|
|
53
|
+
```sh
|
|
54
|
+
python setup.py install --user
|
|
55
|
+
```
|
|
56
|
+
(or `sudo python setup.py install` to install the package for all users)
|
|
57
|
+
|
|
58
|
+
Then import the package:
|
|
59
|
+
```python
|
|
60
|
+
import chickenstats_api
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
### Tests
|
|
64
|
+
|
|
65
|
+
Execute `pytest` to run the tests.
|
|
66
|
+
|
|
67
|
+
## Getting Started
|
|
68
|
+
|
|
69
|
+
Please follow the [installation procedure](#installation--usage) and then run the following:
|
|
70
|
+
|
|
71
|
+
```python
|
|
72
|
+
|
|
73
|
+
import chickenstats_api
|
|
74
|
+
from chickenstats_api.rest import ApiException
|
|
75
|
+
from pprint import pprint
|
|
76
|
+
|
|
77
|
+
# Defining the host is optional and defaults to https://api.chickenstats.com
|
|
78
|
+
# See configuration.py for a list of all supported configuration parameters.
|
|
79
|
+
configuration = chickenstats_api.Configuration(
|
|
80
|
+
host = "https://api.chickenstats.com"
|
|
81
|
+
)
|
|
82
|
+
|
|
83
|
+
# The client must configure the authentication and authorization parameters
|
|
84
|
+
# in accordance with the API server security policy.
|
|
85
|
+
# Examples for each auth method are provided below, use the example that
|
|
86
|
+
# satisfies your auth use case.
|
|
87
|
+
|
|
88
|
+
configuration.access_token = os.environ["ACCESS_TOKEN"]
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
# Enter a context with an instance of the API client
|
|
92
|
+
with chickenstats_api.ApiClient(configuration) as api_client:
|
|
93
|
+
# Create an instance of the API class
|
|
94
|
+
api_instance = chickenstats_api.ChickenNhlApi(api_client)
|
|
95
|
+
lines_create = chickenstats_api.LinesCreate() # LinesCreate |
|
|
96
|
+
|
|
97
|
+
try:
|
|
98
|
+
# Create Lines
|
|
99
|
+
api_response = api_instance.chicken_nhl_create_lines(lines_create)
|
|
100
|
+
print("The response of ChickenNhlApi->chicken_nhl_create_lines:\n")
|
|
101
|
+
pprint(api_response)
|
|
102
|
+
except ApiException as e:
|
|
103
|
+
print("Exception when calling ChickenNhlApi->chicken_nhl_create_lines: %s\n" % e)
|
|
104
|
+
|
|
105
|
+
```
|
|
106
|
+
|
|
107
|
+
## Documentation for API Endpoints
|
|
108
|
+
|
|
109
|
+
All URIs are relative to *https://api.chickenstats.com*
|
|
110
|
+
|
|
111
|
+
Class | Method | HTTP request | Description
|
|
112
|
+
------------ | ------------- | ------------- | -------------
|
|
113
|
+
*ChickenNhlApi* | [**chicken_nhl_create_lines**](docs/ChickenNhlApi.md#chicken_nhl_create_lines) | **POST** /api/v1/chicken_nhl/lines | Create Lines
|
|
114
|
+
*ChickenNhlApi* | [**chicken_nhl_create_pbp**](docs/ChickenNhlApi.md#chicken_nhl_create_pbp) | **POST** /api/v1/chicken_nhl/play_by_play | Create Pbp
|
|
115
|
+
*ChickenNhlApi* | [**chicken_nhl_create_stats**](docs/ChickenNhlApi.md#chicken_nhl_create_stats) | **POST** /api/v1/chicken_nhl/stats | Create Stats
|
|
116
|
+
*ChickenNhlApi* | [**chicken_nhl_create_team_stats**](docs/ChickenNhlApi.md#chicken_nhl_create_team_stats) | **POST** /api/v1/chicken_nhl/team_stats | Create Team Stats
|
|
117
|
+
*ChickenNhlApi* | [**chicken_nhl_read_game_stats**](docs/ChickenNhlApi.md#chicken_nhl_read_game_stats) | **GET** /api/v1/chicken_nhl/stats/game | Read Game Stats
|
|
118
|
+
*ChickenNhlApi* | [**chicken_nhl_read_lines_game_ids**](docs/ChickenNhlApi.md#chicken_nhl_read_lines_game_ids) | **GET** /api/v1/chicken_nhl/lines/game_ids | Read Lines Game Ids
|
|
119
|
+
*ChickenNhlApi* | [**chicken_nhl_read_pbp**](docs/ChickenNhlApi.md#chicken_nhl_read_pbp) | **GET** /api/v1/chicken_nhl/play_by_play | Read Pbp
|
|
120
|
+
*ChickenNhlApi* | [**chicken_nhl_read_pbp_game_ids**](docs/ChickenNhlApi.md#chicken_nhl_read_pbp_game_ids) | **GET** /api/v1/chicken_nhl/play_by_play/game_ids | Read Pbp Game Ids
|
|
121
|
+
*ChickenNhlApi* | [**chicken_nhl_read_pbp_play_ids**](docs/ChickenNhlApi.md#chicken_nhl_read_pbp_play_ids) | **GET** /api/v1/chicken_nhl/play_by_play/play_ids | Read Pbp Play Ids
|
|
122
|
+
*ChickenNhlApi* | [**chicken_nhl_read_season_stats**](docs/ChickenNhlApi.md#chicken_nhl_read_season_stats) | **GET** /api/v1/chicken_nhl/stats/season | Read Season Stats
|
|
123
|
+
*ChickenNhlApi* | [**chicken_nhl_read_stats_game_ids**](docs/ChickenNhlApi.md#chicken_nhl_read_stats_game_ids) | **GET** /api/v1/chicken_nhl/stats/game_ids | Read Stats Game Ids
|
|
124
|
+
*ChickenNhlApi* | [**chicken_nhl_read_team_stats_game_ids**](docs/ChickenNhlApi.md#chicken_nhl_read_team_stats_game_ids) | **GET** /api/v1/chicken_nhl/team_stats/game_ids | Read Team Stats Game Ids
|
|
125
|
+
*GameStatsApi* | [**chicken_nhl_create_stats**](docs/GameStatsApi.md#chicken_nhl_create_stats) | **POST** /api/v1/chicken_nhl/stats | Create Stats
|
|
126
|
+
*GameStatsApi* | [**chicken_nhl_read_game_stats**](docs/GameStatsApi.md#chicken_nhl_read_game_stats) | **GET** /api/v1/chicken_nhl/stats/game | Read Game Stats
|
|
127
|
+
*GameStatsApi* | [**chicken_nhl_read_stats_game_ids**](docs/GameStatsApi.md#chicken_nhl_read_stats_game_ids) | **GET** /api/v1/chicken_nhl/stats/game_ids | Read Stats Game Ids
|
|
128
|
+
*LinesApi* | [**chicken_nhl_create_lines**](docs/LinesApi.md#chicken_nhl_create_lines) | **POST** /api/v1/chicken_nhl/lines | Create Lines
|
|
129
|
+
*LinesApi* | [**chicken_nhl_read_lines_game_ids**](docs/LinesApi.md#chicken_nhl_read_lines_game_ids) | **GET** /api/v1/chicken_nhl/lines/game_ids | Read Lines Game Ids
|
|
130
|
+
*LinesApi* | [**chicken_nhl_read_team_stats_game_ids**](docs/LinesApi.md#chicken_nhl_read_team_stats_game_ids) | **GET** /api/v1/chicken_nhl/team_stats/game_ids | Read Team Stats Game Ids
|
|
131
|
+
*LoginApi* | [**login_login_access_token**](docs/LoginApi.md#login_login_access_token) | **POST** /api/v1/login/access-token | Login Access Token
|
|
132
|
+
*LoginApi* | [**login_recover_password**](docs/LoginApi.md#login_recover_password) | **POST** /api/v1/password-recovery/{email} | Recover Password
|
|
133
|
+
*LoginApi* | [**login_recover_password_html_content**](docs/LoginApi.md#login_recover_password_html_content) | **POST** /api/v1/password-recovery-html-content/{email} | Recover Password Html Content
|
|
134
|
+
*LoginApi* | [**login_reset_password**](docs/LoginApi.md#login_reset_password) | **POST** /api/v1/reset-password/ | Reset Password
|
|
135
|
+
*LoginApi* | [**login_test_token**](docs/LoginApi.md#login_test_token) | **POST** /api/v1/login/test-token | Test Token
|
|
136
|
+
*PlayByPlayApi* | [**chicken_nhl_create_pbp**](docs/PlayByPlayApi.md#chicken_nhl_create_pbp) | **POST** /api/v1/chicken_nhl/play_by_play | Create Pbp
|
|
137
|
+
*PlayByPlayApi* | [**chicken_nhl_read_pbp**](docs/PlayByPlayApi.md#chicken_nhl_read_pbp) | **GET** /api/v1/chicken_nhl/play_by_play | Read Pbp
|
|
138
|
+
*PlayByPlayApi* | [**chicken_nhl_read_pbp_game_ids**](docs/PlayByPlayApi.md#chicken_nhl_read_pbp_game_ids) | **GET** /api/v1/chicken_nhl/play_by_play/game_ids | Read Pbp Game Ids
|
|
139
|
+
*PlayByPlayApi* | [**chicken_nhl_read_pbp_play_ids**](docs/PlayByPlayApi.md#chicken_nhl_read_pbp_play_ids) | **GET** /api/v1/chicken_nhl/play_by_play/play_ids | Read Pbp Play Ids
|
|
140
|
+
*SeasonStatsApi* | [**chicken_nhl_read_season_stats**](docs/SeasonStatsApi.md#chicken_nhl_read_season_stats) | **GET** /api/v1/chicken_nhl/stats/season | Read Season Stats
|
|
141
|
+
*StatsApi* | [**chicken_nhl_create_stats**](docs/StatsApi.md#chicken_nhl_create_stats) | **POST** /api/v1/chicken_nhl/stats | Create Stats
|
|
142
|
+
*StatsApi* | [**chicken_nhl_read_game_stats**](docs/StatsApi.md#chicken_nhl_read_game_stats) | **GET** /api/v1/chicken_nhl/stats/game | Read Game Stats
|
|
143
|
+
*StatsApi* | [**chicken_nhl_read_season_stats**](docs/StatsApi.md#chicken_nhl_read_season_stats) | **GET** /api/v1/chicken_nhl/stats/season | Read Season Stats
|
|
144
|
+
*StatsApi* | [**chicken_nhl_read_stats_game_ids**](docs/StatsApi.md#chicken_nhl_read_stats_game_ids) | **GET** /api/v1/chicken_nhl/stats/game_ids | Read Stats Game Ids
|
|
145
|
+
*TeamStatsApi* | [**chicken_nhl_create_team_stats**](docs/TeamStatsApi.md#chicken_nhl_create_team_stats) | **POST** /api/v1/chicken_nhl/team_stats | Create Team Stats
|
|
146
|
+
*UsersApi* | [**users_create_user**](docs/UsersApi.md#users_create_user) | **POST** /api/v1/users/ | Create User
|
|
147
|
+
*UsersApi* | [**users_delete_user**](docs/UsersApi.md#users_delete_user) | **DELETE** /api/v1/users/{user_id} | Delete User
|
|
148
|
+
*UsersApi* | [**users_delete_user_me**](docs/UsersApi.md#users_delete_user_me) | **DELETE** /api/v1/users/me | Delete User Me
|
|
149
|
+
*UsersApi* | [**users_read_user_by_id**](docs/UsersApi.md#users_read_user_by_id) | **GET** /api/v1/users/{user_id} | Read User By Id
|
|
150
|
+
*UsersApi* | [**users_read_user_me**](docs/UsersApi.md#users_read_user_me) | **GET** /api/v1/users/me | Read User Me
|
|
151
|
+
*UsersApi* | [**users_read_users**](docs/UsersApi.md#users_read_users) | **GET** /api/v1/users/ | Read Users
|
|
152
|
+
*UsersApi* | [**users_update_password_me**](docs/UsersApi.md#users_update_password_me) | **PATCH** /api/v1/users/me/password | Update Password Me
|
|
153
|
+
*UsersApi* | [**users_update_user**](docs/UsersApi.md#users_update_user) | **PATCH** /api/v1/users/{user_id} | Update User
|
|
154
|
+
*UsersApi* | [**users_update_user_me**](docs/UsersApi.md#users_update_user_me) | **PATCH** /api/v1/users/me | Update User Me
|
|
155
|
+
|
|
156
|
+
|
|
157
|
+
## Documentation For Models
|
|
158
|
+
|
|
159
|
+
- [HTTPValidationError](docs/HTTPValidationError.md)
|
|
160
|
+
- [LinesCreate](docs/LinesCreate.md)
|
|
161
|
+
- [LinesPublic](docs/LinesPublic.md)
|
|
162
|
+
- [Message](docs/Message.md)
|
|
163
|
+
- [NewPassword](docs/NewPassword.md)
|
|
164
|
+
- [PbpPublic](docs/PbpPublic.md)
|
|
165
|
+
- [StatsCreate](docs/StatsCreate.md)
|
|
166
|
+
- [StatsGame](docs/StatsGame.md)
|
|
167
|
+
- [StatsSeason](docs/StatsSeason.md)
|
|
168
|
+
- [TeamStatsCreate](docs/TeamStatsCreate.md)
|
|
169
|
+
- [TeamStatsPublic](docs/TeamStatsPublic.md)
|
|
170
|
+
- [Token](docs/Token.md)
|
|
171
|
+
- [UpdatePassword](docs/UpdatePassword.md)
|
|
172
|
+
- [UserCreate](docs/UserCreate.md)
|
|
173
|
+
- [UserPublic](docs/UserPublic.md)
|
|
174
|
+
- [UserUpdate](docs/UserUpdate.md)
|
|
175
|
+
- [UserUpdateMe](docs/UserUpdateMe.md)
|
|
176
|
+
- [UsersPublic](docs/UsersPublic.md)
|
|
177
|
+
- [ValidationError](docs/ValidationError.md)
|
|
178
|
+
- [ValidationErrorLocInner](docs/ValidationErrorLocInner.md)
|
|
179
|
+
|
|
180
|
+
|
|
181
|
+
<a id="documentation-for-authorization"></a>
|
|
182
|
+
## Documentation For Authorization
|
|
183
|
+
|
|
184
|
+
|
|
185
|
+
Authentication schemes defined for the API:
|
|
186
|
+
<a id="OAuth2PasswordBearer"></a>
|
|
187
|
+
### OAuth2PasswordBearer
|
|
188
|
+
|
|
189
|
+
- **Type**: OAuth
|
|
190
|
+
- **Flow**: password
|
|
191
|
+
- **Authorization URL**:
|
|
192
|
+
- **Scopes**: N/A
|
|
193
|
+
|
|
194
|
+
|
|
195
|
+
## Author
|
|
196
|
+
|
|
197
|
+
chicken@chickenandstats.com
|
|
198
|
+
|
|
199
|
+
|
|
@@ -0,0 +1,181 @@
|
|
|
1
|
+
# chickenstats-api
|
|
2
|
+
API for downloading NHL data
|
|
3
|
+
|
|
4
|
+
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
|
5
|
+
|
|
6
|
+
- API version: 0.1.0
|
|
7
|
+
- Package version: 0.0.1
|
|
8
|
+
- Generator version: 7.14.0
|
|
9
|
+
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
|
|
10
|
+
For more information, please visit [https://api.chickenstats.com/](https://api.chickenstats.com/)
|
|
11
|
+
|
|
12
|
+
## Requirements.
|
|
13
|
+
|
|
14
|
+
Python 3.9+
|
|
15
|
+
|
|
16
|
+
## Installation & Usage
|
|
17
|
+
### pip install
|
|
18
|
+
|
|
19
|
+
If the python package is hosted on a repository, you can install directly using:
|
|
20
|
+
|
|
21
|
+
```sh
|
|
22
|
+
pip install git+https://github.com/chickenandstats/chickenstats-api-python.git
|
|
23
|
+
```
|
|
24
|
+
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/chickenandstats/chickenstats-api-python.git`)
|
|
25
|
+
|
|
26
|
+
Then import the package:
|
|
27
|
+
```python
|
|
28
|
+
import chickenstats_api
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
### Setuptools
|
|
32
|
+
|
|
33
|
+
Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
|
|
34
|
+
|
|
35
|
+
```sh
|
|
36
|
+
python setup.py install --user
|
|
37
|
+
```
|
|
38
|
+
(or `sudo python setup.py install` to install the package for all users)
|
|
39
|
+
|
|
40
|
+
Then import the package:
|
|
41
|
+
```python
|
|
42
|
+
import chickenstats_api
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
### Tests
|
|
46
|
+
|
|
47
|
+
Execute `pytest` to run the tests.
|
|
48
|
+
|
|
49
|
+
## Getting Started
|
|
50
|
+
|
|
51
|
+
Please follow the [installation procedure](#installation--usage) and then run the following:
|
|
52
|
+
|
|
53
|
+
```python
|
|
54
|
+
|
|
55
|
+
import chickenstats_api
|
|
56
|
+
from chickenstats_api.rest import ApiException
|
|
57
|
+
from pprint import pprint
|
|
58
|
+
|
|
59
|
+
# Defining the host is optional and defaults to https://api.chickenstats.com
|
|
60
|
+
# See configuration.py for a list of all supported configuration parameters.
|
|
61
|
+
configuration = chickenstats_api.Configuration(
|
|
62
|
+
host = "https://api.chickenstats.com"
|
|
63
|
+
)
|
|
64
|
+
|
|
65
|
+
# The client must configure the authentication and authorization parameters
|
|
66
|
+
# in accordance with the API server security policy.
|
|
67
|
+
# Examples for each auth method are provided below, use the example that
|
|
68
|
+
# satisfies your auth use case.
|
|
69
|
+
|
|
70
|
+
configuration.access_token = os.environ["ACCESS_TOKEN"]
|
|
71
|
+
|
|
72
|
+
|
|
73
|
+
# Enter a context with an instance of the API client
|
|
74
|
+
with chickenstats_api.ApiClient(configuration) as api_client:
|
|
75
|
+
# Create an instance of the API class
|
|
76
|
+
api_instance = chickenstats_api.ChickenNhlApi(api_client)
|
|
77
|
+
lines_create = chickenstats_api.LinesCreate() # LinesCreate |
|
|
78
|
+
|
|
79
|
+
try:
|
|
80
|
+
# Create Lines
|
|
81
|
+
api_response = api_instance.chicken_nhl_create_lines(lines_create)
|
|
82
|
+
print("The response of ChickenNhlApi->chicken_nhl_create_lines:\n")
|
|
83
|
+
pprint(api_response)
|
|
84
|
+
except ApiException as e:
|
|
85
|
+
print("Exception when calling ChickenNhlApi->chicken_nhl_create_lines: %s\n" % e)
|
|
86
|
+
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
## Documentation for API Endpoints
|
|
90
|
+
|
|
91
|
+
All URIs are relative to *https://api.chickenstats.com*
|
|
92
|
+
|
|
93
|
+
Class | Method | HTTP request | Description
|
|
94
|
+
------------ | ------------- | ------------- | -------------
|
|
95
|
+
*ChickenNhlApi* | [**chicken_nhl_create_lines**](docs/ChickenNhlApi.md#chicken_nhl_create_lines) | **POST** /api/v1/chicken_nhl/lines | Create Lines
|
|
96
|
+
*ChickenNhlApi* | [**chicken_nhl_create_pbp**](docs/ChickenNhlApi.md#chicken_nhl_create_pbp) | **POST** /api/v1/chicken_nhl/play_by_play | Create Pbp
|
|
97
|
+
*ChickenNhlApi* | [**chicken_nhl_create_stats**](docs/ChickenNhlApi.md#chicken_nhl_create_stats) | **POST** /api/v1/chicken_nhl/stats | Create Stats
|
|
98
|
+
*ChickenNhlApi* | [**chicken_nhl_create_team_stats**](docs/ChickenNhlApi.md#chicken_nhl_create_team_stats) | **POST** /api/v1/chicken_nhl/team_stats | Create Team Stats
|
|
99
|
+
*ChickenNhlApi* | [**chicken_nhl_read_game_stats**](docs/ChickenNhlApi.md#chicken_nhl_read_game_stats) | **GET** /api/v1/chicken_nhl/stats/game | Read Game Stats
|
|
100
|
+
*ChickenNhlApi* | [**chicken_nhl_read_lines_game_ids**](docs/ChickenNhlApi.md#chicken_nhl_read_lines_game_ids) | **GET** /api/v1/chicken_nhl/lines/game_ids | Read Lines Game Ids
|
|
101
|
+
*ChickenNhlApi* | [**chicken_nhl_read_pbp**](docs/ChickenNhlApi.md#chicken_nhl_read_pbp) | **GET** /api/v1/chicken_nhl/play_by_play | Read Pbp
|
|
102
|
+
*ChickenNhlApi* | [**chicken_nhl_read_pbp_game_ids**](docs/ChickenNhlApi.md#chicken_nhl_read_pbp_game_ids) | **GET** /api/v1/chicken_nhl/play_by_play/game_ids | Read Pbp Game Ids
|
|
103
|
+
*ChickenNhlApi* | [**chicken_nhl_read_pbp_play_ids**](docs/ChickenNhlApi.md#chicken_nhl_read_pbp_play_ids) | **GET** /api/v1/chicken_nhl/play_by_play/play_ids | Read Pbp Play Ids
|
|
104
|
+
*ChickenNhlApi* | [**chicken_nhl_read_season_stats**](docs/ChickenNhlApi.md#chicken_nhl_read_season_stats) | **GET** /api/v1/chicken_nhl/stats/season | Read Season Stats
|
|
105
|
+
*ChickenNhlApi* | [**chicken_nhl_read_stats_game_ids**](docs/ChickenNhlApi.md#chicken_nhl_read_stats_game_ids) | **GET** /api/v1/chicken_nhl/stats/game_ids | Read Stats Game Ids
|
|
106
|
+
*ChickenNhlApi* | [**chicken_nhl_read_team_stats_game_ids**](docs/ChickenNhlApi.md#chicken_nhl_read_team_stats_game_ids) | **GET** /api/v1/chicken_nhl/team_stats/game_ids | Read Team Stats Game Ids
|
|
107
|
+
*GameStatsApi* | [**chicken_nhl_create_stats**](docs/GameStatsApi.md#chicken_nhl_create_stats) | **POST** /api/v1/chicken_nhl/stats | Create Stats
|
|
108
|
+
*GameStatsApi* | [**chicken_nhl_read_game_stats**](docs/GameStatsApi.md#chicken_nhl_read_game_stats) | **GET** /api/v1/chicken_nhl/stats/game | Read Game Stats
|
|
109
|
+
*GameStatsApi* | [**chicken_nhl_read_stats_game_ids**](docs/GameStatsApi.md#chicken_nhl_read_stats_game_ids) | **GET** /api/v1/chicken_nhl/stats/game_ids | Read Stats Game Ids
|
|
110
|
+
*LinesApi* | [**chicken_nhl_create_lines**](docs/LinesApi.md#chicken_nhl_create_lines) | **POST** /api/v1/chicken_nhl/lines | Create Lines
|
|
111
|
+
*LinesApi* | [**chicken_nhl_read_lines_game_ids**](docs/LinesApi.md#chicken_nhl_read_lines_game_ids) | **GET** /api/v1/chicken_nhl/lines/game_ids | Read Lines Game Ids
|
|
112
|
+
*LinesApi* | [**chicken_nhl_read_team_stats_game_ids**](docs/LinesApi.md#chicken_nhl_read_team_stats_game_ids) | **GET** /api/v1/chicken_nhl/team_stats/game_ids | Read Team Stats Game Ids
|
|
113
|
+
*LoginApi* | [**login_login_access_token**](docs/LoginApi.md#login_login_access_token) | **POST** /api/v1/login/access-token | Login Access Token
|
|
114
|
+
*LoginApi* | [**login_recover_password**](docs/LoginApi.md#login_recover_password) | **POST** /api/v1/password-recovery/{email} | Recover Password
|
|
115
|
+
*LoginApi* | [**login_recover_password_html_content**](docs/LoginApi.md#login_recover_password_html_content) | **POST** /api/v1/password-recovery-html-content/{email} | Recover Password Html Content
|
|
116
|
+
*LoginApi* | [**login_reset_password**](docs/LoginApi.md#login_reset_password) | **POST** /api/v1/reset-password/ | Reset Password
|
|
117
|
+
*LoginApi* | [**login_test_token**](docs/LoginApi.md#login_test_token) | **POST** /api/v1/login/test-token | Test Token
|
|
118
|
+
*PlayByPlayApi* | [**chicken_nhl_create_pbp**](docs/PlayByPlayApi.md#chicken_nhl_create_pbp) | **POST** /api/v1/chicken_nhl/play_by_play | Create Pbp
|
|
119
|
+
*PlayByPlayApi* | [**chicken_nhl_read_pbp**](docs/PlayByPlayApi.md#chicken_nhl_read_pbp) | **GET** /api/v1/chicken_nhl/play_by_play | Read Pbp
|
|
120
|
+
*PlayByPlayApi* | [**chicken_nhl_read_pbp_game_ids**](docs/PlayByPlayApi.md#chicken_nhl_read_pbp_game_ids) | **GET** /api/v1/chicken_nhl/play_by_play/game_ids | Read Pbp Game Ids
|
|
121
|
+
*PlayByPlayApi* | [**chicken_nhl_read_pbp_play_ids**](docs/PlayByPlayApi.md#chicken_nhl_read_pbp_play_ids) | **GET** /api/v1/chicken_nhl/play_by_play/play_ids | Read Pbp Play Ids
|
|
122
|
+
*SeasonStatsApi* | [**chicken_nhl_read_season_stats**](docs/SeasonStatsApi.md#chicken_nhl_read_season_stats) | **GET** /api/v1/chicken_nhl/stats/season | Read Season Stats
|
|
123
|
+
*StatsApi* | [**chicken_nhl_create_stats**](docs/StatsApi.md#chicken_nhl_create_stats) | **POST** /api/v1/chicken_nhl/stats | Create Stats
|
|
124
|
+
*StatsApi* | [**chicken_nhl_read_game_stats**](docs/StatsApi.md#chicken_nhl_read_game_stats) | **GET** /api/v1/chicken_nhl/stats/game | Read Game Stats
|
|
125
|
+
*StatsApi* | [**chicken_nhl_read_season_stats**](docs/StatsApi.md#chicken_nhl_read_season_stats) | **GET** /api/v1/chicken_nhl/stats/season | Read Season Stats
|
|
126
|
+
*StatsApi* | [**chicken_nhl_read_stats_game_ids**](docs/StatsApi.md#chicken_nhl_read_stats_game_ids) | **GET** /api/v1/chicken_nhl/stats/game_ids | Read Stats Game Ids
|
|
127
|
+
*TeamStatsApi* | [**chicken_nhl_create_team_stats**](docs/TeamStatsApi.md#chicken_nhl_create_team_stats) | **POST** /api/v1/chicken_nhl/team_stats | Create Team Stats
|
|
128
|
+
*UsersApi* | [**users_create_user**](docs/UsersApi.md#users_create_user) | **POST** /api/v1/users/ | Create User
|
|
129
|
+
*UsersApi* | [**users_delete_user**](docs/UsersApi.md#users_delete_user) | **DELETE** /api/v1/users/{user_id} | Delete User
|
|
130
|
+
*UsersApi* | [**users_delete_user_me**](docs/UsersApi.md#users_delete_user_me) | **DELETE** /api/v1/users/me | Delete User Me
|
|
131
|
+
*UsersApi* | [**users_read_user_by_id**](docs/UsersApi.md#users_read_user_by_id) | **GET** /api/v1/users/{user_id} | Read User By Id
|
|
132
|
+
*UsersApi* | [**users_read_user_me**](docs/UsersApi.md#users_read_user_me) | **GET** /api/v1/users/me | Read User Me
|
|
133
|
+
*UsersApi* | [**users_read_users**](docs/UsersApi.md#users_read_users) | **GET** /api/v1/users/ | Read Users
|
|
134
|
+
*UsersApi* | [**users_update_password_me**](docs/UsersApi.md#users_update_password_me) | **PATCH** /api/v1/users/me/password | Update Password Me
|
|
135
|
+
*UsersApi* | [**users_update_user**](docs/UsersApi.md#users_update_user) | **PATCH** /api/v1/users/{user_id} | Update User
|
|
136
|
+
*UsersApi* | [**users_update_user_me**](docs/UsersApi.md#users_update_user_me) | **PATCH** /api/v1/users/me | Update User Me
|
|
137
|
+
|
|
138
|
+
|
|
139
|
+
## Documentation For Models
|
|
140
|
+
|
|
141
|
+
- [HTTPValidationError](docs/HTTPValidationError.md)
|
|
142
|
+
- [LinesCreate](docs/LinesCreate.md)
|
|
143
|
+
- [LinesPublic](docs/LinesPublic.md)
|
|
144
|
+
- [Message](docs/Message.md)
|
|
145
|
+
- [NewPassword](docs/NewPassword.md)
|
|
146
|
+
- [PbpPublic](docs/PbpPublic.md)
|
|
147
|
+
- [StatsCreate](docs/StatsCreate.md)
|
|
148
|
+
- [StatsGame](docs/StatsGame.md)
|
|
149
|
+
- [StatsSeason](docs/StatsSeason.md)
|
|
150
|
+
- [TeamStatsCreate](docs/TeamStatsCreate.md)
|
|
151
|
+
- [TeamStatsPublic](docs/TeamStatsPublic.md)
|
|
152
|
+
- [Token](docs/Token.md)
|
|
153
|
+
- [UpdatePassword](docs/UpdatePassword.md)
|
|
154
|
+
- [UserCreate](docs/UserCreate.md)
|
|
155
|
+
- [UserPublic](docs/UserPublic.md)
|
|
156
|
+
- [UserUpdate](docs/UserUpdate.md)
|
|
157
|
+
- [UserUpdateMe](docs/UserUpdateMe.md)
|
|
158
|
+
- [UsersPublic](docs/UsersPublic.md)
|
|
159
|
+
- [ValidationError](docs/ValidationError.md)
|
|
160
|
+
- [ValidationErrorLocInner](docs/ValidationErrorLocInner.md)
|
|
161
|
+
|
|
162
|
+
|
|
163
|
+
<a id="documentation-for-authorization"></a>
|
|
164
|
+
## Documentation For Authorization
|
|
165
|
+
|
|
166
|
+
|
|
167
|
+
Authentication schemes defined for the API:
|
|
168
|
+
<a id="OAuth2PasswordBearer"></a>
|
|
169
|
+
### OAuth2PasswordBearer
|
|
170
|
+
|
|
171
|
+
- **Type**: OAuth
|
|
172
|
+
- **Flow**: password
|
|
173
|
+
- **Authorization URL**:
|
|
174
|
+
- **Scopes**: N/A
|
|
175
|
+
|
|
176
|
+
|
|
177
|
+
## Author
|
|
178
|
+
|
|
179
|
+
chicken@chickenandstats.com
|
|
180
|
+
|
|
181
|
+
|
|
@@ -0,0 +1,104 @@
|
|
|
1
|
+
# coding: utf-8
|
|
2
|
+
|
|
3
|
+
# flake8: noqa
|
|
4
|
+
|
|
5
|
+
"""
|
|
6
|
+
chickenstats API
|
|
7
|
+
|
|
8
|
+
API for downloading NHL data
|
|
9
|
+
|
|
10
|
+
The version of the OpenAPI document: 0.1.0
|
|
11
|
+
Contact: chicken@chickenandstats.com
|
|
12
|
+
Generated by OpenAPI Generator (https://openapi-generator.tech)
|
|
13
|
+
|
|
14
|
+
Do not edit the class manually.
|
|
15
|
+
""" # noqa: E501
|
|
16
|
+
|
|
17
|
+
|
|
18
|
+
__version__ = "0.0.1"
|
|
19
|
+
|
|
20
|
+
# Define package exports
|
|
21
|
+
__all__ = [
|
|
22
|
+
"ChickenNhlApi",
|
|
23
|
+
"GameStatsApi",
|
|
24
|
+
"LinesApi",
|
|
25
|
+
"LoginApi",
|
|
26
|
+
"PlayByPlayApi",
|
|
27
|
+
"SeasonStatsApi",
|
|
28
|
+
"StatsApi",
|
|
29
|
+
"TeamStatsApi",
|
|
30
|
+
"UsersApi",
|
|
31
|
+
"ApiResponse",
|
|
32
|
+
"ApiClient",
|
|
33
|
+
"Configuration",
|
|
34
|
+
"OpenApiException",
|
|
35
|
+
"ApiTypeError",
|
|
36
|
+
"ApiValueError",
|
|
37
|
+
"ApiKeyError",
|
|
38
|
+
"ApiAttributeError",
|
|
39
|
+
"ApiException",
|
|
40
|
+
"HTTPValidationError",
|
|
41
|
+
"LinesCreate",
|
|
42
|
+
"LinesPublic",
|
|
43
|
+
"Message",
|
|
44
|
+
"NewPassword",
|
|
45
|
+
"PbpPublic",
|
|
46
|
+
"StatsCreate",
|
|
47
|
+
"StatsGame",
|
|
48
|
+
"StatsSeason",
|
|
49
|
+
"TeamStatsCreate",
|
|
50
|
+
"TeamStatsPublic",
|
|
51
|
+
"Token",
|
|
52
|
+
"UpdatePassword",
|
|
53
|
+
"UserCreate",
|
|
54
|
+
"UserPublic",
|
|
55
|
+
"UserUpdate",
|
|
56
|
+
"UserUpdateMe",
|
|
57
|
+
"UsersPublic",
|
|
58
|
+
"ValidationError",
|
|
59
|
+
"ValidationErrorLocInner",
|
|
60
|
+
]
|
|
61
|
+
|
|
62
|
+
# import apis into sdk package
|
|
63
|
+
from chickenstats_api.api.chicken_nhl_api import ChickenNhlApi as ChickenNhlApi
|
|
64
|
+
from chickenstats_api.api.game_stats_api import GameStatsApi as GameStatsApi
|
|
65
|
+
from chickenstats_api.api.lines_api import LinesApi as LinesApi
|
|
66
|
+
from chickenstats_api.api.login_api import LoginApi as LoginApi
|
|
67
|
+
from chickenstats_api.api.play_by_play_api import PlayByPlayApi as PlayByPlayApi
|
|
68
|
+
from chickenstats_api.api.season_stats_api import SeasonStatsApi as SeasonStatsApi
|
|
69
|
+
from chickenstats_api.api.stats_api import StatsApi as StatsApi
|
|
70
|
+
from chickenstats_api.api.team_stats_api import TeamStatsApi as TeamStatsApi
|
|
71
|
+
from chickenstats_api.api.users_api import UsersApi as UsersApi
|
|
72
|
+
|
|
73
|
+
# import ApiClient
|
|
74
|
+
from chickenstats_api.api_response import ApiResponse as ApiResponse
|
|
75
|
+
from chickenstats_api.api_client import ApiClient as ApiClient
|
|
76
|
+
from chickenstats_api.configuration import Configuration as Configuration
|
|
77
|
+
from chickenstats_api.exceptions import OpenApiException as OpenApiException
|
|
78
|
+
from chickenstats_api.exceptions import ApiTypeError as ApiTypeError
|
|
79
|
+
from chickenstats_api.exceptions import ApiValueError as ApiValueError
|
|
80
|
+
from chickenstats_api.exceptions import ApiKeyError as ApiKeyError
|
|
81
|
+
from chickenstats_api.exceptions import ApiAttributeError as ApiAttributeError
|
|
82
|
+
from chickenstats_api.exceptions import ApiException as ApiException
|
|
83
|
+
|
|
84
|
+
# import models into sdk package
|
|
85
|
+
from chickenstats_api.models.http_validation_error import HTTPValidationError as HTTPValidationError
|
|
86
|
+
from chickenstats_api.models.lines_create import LinesCreate as LinesCreate
|
|
87
|
+
from chickenstats_api.models.lines_public import LinesPublic as LinesPublic
|
|
88
|
+
from chickenstats_api.models.message import Message as Message
|
|
89
|
+
from chickenstats_api.models.new_password import NewPassword as NewPassword
|
|
90
|
+
from chickenstats_api.models.pbp_public import PbpPublic as PbpPublic
|
|
91
|
+
from chickenstats_api.models.stats_create import StatsCreate as StatsCreate
|
|
92
|
+
from chickenstats_api.models.stats_game import StatsGame as StatsGame
|
|
93
|
+
from chickenstats_api.models.stats_season import StatsSeason as StatsSeason
|
|
94
|
+
from chickenstats_api.models.team_stats_create import TeamStatsCreate as TeamStatsCreate
|
|
95
|
+
from chickenstats_api.models.team_stats_public import TeamStatsPublic as TeamStatsPublic
|
|
96
|
+
from chickenstats_api.models.token import Token as Token
|
|
97
|
+
from chickenstats_api.models.update_password import UpdatePassword as UpdatePassword
|
|
98
|
+
from chickenstats_api.models.user_create import UserCreate as UserCreate
|
|
99
|
+
from chickenstats_api.models.user_public import UserPublic as UserPublic
|
|
100
|
+
from chickenstats_api.models.user_update import UserUpdate as UserUpdate
|
|
101
|
+
from chickenstats_api.models.user_update_me import UserUpdateMe as UserUpdateMe
|
|
102
|
+
from chickenstats_api.models.users_public import UsersPublic as UsersPublic
|
|
103
|
+
from chickenstats_api.models.validation_error import ValidationError as ValidationError
|
|
104
|
+
from chickenstats_api.models.validation_error_loc_inner import ValidationErrorLocInner as ValidationErrorLocInner
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
# flake8: noqa
|
|
2
|
+
|
|
3
|
+
# import apis into api package
|
|
4
|
+
from chickenstats_api.api.chicken_nhl_api import ChickenNhlApi
|
|
5
|
+
from chickenstats_api.api.game_stats_api import GameStatsApi
|
|
6
|
+
from chickenstats_api.api.lines_api import LinesApi
|
|
7
|
+
from chickenstats_api.api.login_api import LoginApi
|
|
8
|
+
from chickenstats_api.api.play_by_play_api import PlayByPlayApi
|
|
9
|
+
from chickenstats_api.api.season_stats_api import SeasonStatsApi
|
|
10
|
+
from chickenstats_api.api.stats_api import StatsApi
|
|
11
|
+
from chickenstats_api.api.team_stats_api import TeamStatsApi
|
|
12
|
+
from chickenstats_api.api.users_api import UsersApi
|
|
13
|
+
|