chickenstats-api 0.0.1

chickenstats API

chickenstats-api

API for downloading NHL data

This Python package is automatically generated by the OpenAPI Generator project:

• API version: 0.1.0
• Package version: 0.0.1
• Generator version: 7.14.0
• Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit https://api.chickenstats.com/

Requirements.

Python 3.9+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/chickenandstats/chickenstats-api-python.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/chickenandstats/chickenstats-api-python.git)

Then import the package:

import chickenstats_api

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import chickenstats_api

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import chickenstats_api
from chickenstats_api.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.chickenstats.com
# See configuration.py for a list of all supported configuration parameters.
configuration = chickenstats_api.Configuration(
    host = "https://api.chickenstats.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.access_token = os.environ["ACCESS_TOKEN"]


# Enter a context with an instance of the API client
with chickenstats_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = chickenstats_api.ChickenNhlApi(api_client)
    lines_create = chickenstats_api.LinesCreate() # LinesCreate | 

    try:
        # Create Lines
        api_response = api_instance.chicken_nhl_create_lines(lines_create)
        print("The response of ChickenNhlApi->chicken_nhl_create_lines:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ChickenNhlApi->chicken_nhl_create_lines: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://api.chickenstats.com

Class	Method	HTTP request	Description
ChickenNhlApi	chicken_nhl_create_lines	POST /api/v1/chicken_nhl/lines	Create Lines
ChickenNhlApi	chicken_nhl_create_pbp	POST /api/v1/chicken_nhl/play_by_play	Create Pbp
ChickenNhlApi	chicken_nhl_create_stats	POST /api/v1/chicken_nhl/stats	Create Stats
ChickenNhlApi	chicken_nhl_create_team_stats	POST /api/v1/chicken_nhl/team_stats	Create Team Stats
ChickenNhlApi	chicken_nhl_read_game_stats	GET /api/v1/chicken_nhl/stats/game	Read Game Stats
ChickenNhlApi	chicken_nhl_read_lines_game_ids	GET /api/v1/chicken_nhl/lines/game_ids	Read Lines Game Ids
ChickenNhlApi	chicken_nhl_read_pbp	GET /api/v1/chicken_nhl/play_by_play	Read Pbp
ChickenNhlApi	chicken_nhl_read_pbp_game_ids	GET /api/v1/chicken_nhl/play_by_play/game_ids	Read Pbp Game Ids
ChickenNhlApi	chicken_nhl_read_pbp_play_ids	GET /api/v1/chicken_nhl/play_by_play/play_ids	Read Pbp Play Ids
ChickenNhlApi	chicken_nhl_read_season_stats	GET /api/v1/chicken_nhl/stats/season	Read Season Stats
ChickenNhlApi	chicken_nhl_read_stats_game_ids	GET /api/v1/chicken_nhl/stats/game_ids	Read Stats Game Ids
ChickenNhlApi	chicken_nhl_read_team_stats_game_ids	GET /api/v1/chicken_nhl/team_stats/game_ids	Read Team Stats Game Ids
GameStatsApi	chicken_nhl_create_stats	POST /api/v1/chicken_nhl/stats	Create Stats
GameStatsApi	chicken_nhl_read_game_stats	GET /api/v1/chicken_nhl/stats/game	Read Game Stats
GameStatsApi	chicken_nhl_read_stats_game_ids	GET /api/v1/chicken_nhl/stats/game_ids	Read Stats Game Ids
LinesApi	chicken_nhl_create_lines	POST /api/v1/chicken_nhl/lines	Create Lines
LinesApi	chicken_nhl_read_lines_game_ids	GET /api/v1/chicken_nhl/lines/game_ids	Read Lines Game Ids
LinesApi	chicken_nhl_read_team_stats_game_ids	GET /api/v1/chicken_nhl/team_stats/game_ids	Read Team Stats Game Ids
LoginApi	login_login_access_token	POST /api/v1/login/access-token	Login Access Token
LoginApi	login_recover_password	POST /api/v1/password-recovery/{email}	Recover Password
LoginApi	login_recover_password_html_content	POST /api/v1/password-recovery-html-content/{email}	Recover Password Html Content
LoginApi	login_reset_password	POST /api/v1/reset-password/	Reset Password
LoginApi	login_test_token	POST /api/v1/login/test-token	Test Token
PlayByPlayApi	chicken_nhl_create_pbp	POST /api/v1/chicken_nhl/play_by_play	Create Pbp
PlayByPlayApi	chicken_nhl_read_pbp	GET /api/v1/chicken_nhl/play_by_play	Read Pbp
PlayByPlayApi	chicken_nhl_read_pbp_game_ids	GET /api/v1/chicken_nhl/play_by_play/game_ids	Read Pbp Game Ids
PlayByPlayApi	chicken_nhl_read_pbp_play_ids	GET /api/v1/chicken_nhl/play_by_play/play_ids	Read Pbp Play Ids
SeasonStatsApi	chicken_nhl_read_season_stats	GET /api/v1/chicken_nhl/stats/season	Read Season Stats
StatsApi	chicken_nhl_create_stats	POST /api/v1/chicken_nhl/stats	Create Stats
StatsApi	chicken_nhl_read_game_stats	GET /api/v1/chicken_nhl/stats/game	Read Game Stats
StatsApi	chicken_nhl_read_season_stats	GET /api/v1/chicken_nhl/stats/season	Read Season Stats
StatsApi	chicken_nhl_read_stats_game_ids	GET /api/v1/chicken_nhl/stats/game_ids	Read Stats Game Ids
TeamStatsApi	chicken_nhl_create_team_stats	POST /api/v1/chicken_nhl/team_stats	Create Team Stats
UsersApi	users_create_user	POST /api/v1/users/	Create User
UsersApi	users_delete_user	DELETE /api/v1/users/{user_id}	Delete User
UsersApi	users_delete_user_me	DELETE /api/v1/users/me	Delete User Me
UsersApi	users_read_user_by_id	GET /api/v1/users/{user_id}	Read User By Id
UsersApi	users_read_user_me	GET /api/v1/users/me	Read User Me
UsersApi	users_read_users	GET /api/v1/users/	Read Users
UsersApi	users_update_password_me	PATCH /api/v1/users/me/password	Update Password Me
UsersApi	users_update_user	PATCH /api/v1/users/{user_id}	Update User
UsersApi	users_update_user_me	PATCH /api/v1/users/me	Update User Me

Documentation For Models

• HTTPValidationError
• LinesCreate
• LinesPublic
• Message
• NewPassword
• PbpPublic
• StatsCreate
• StatsGame
• StatsSeason
• TeamStatsCreate
• TeamStatsPublic
• Token
• UpdatePassword
• UserCreate
• UserPublic
• UserUpdate
• UserUpdateMe
• UsersPublic
• ValidationError
• ValidationErrorLocInner

Documentation For Authorization

Authentication schemes defined for the API:

OAuth2PasswordBearer

• Type: OAuth
• Flow: password
• Authorization URL:
• Scopes: N/A

Author

[e-mail]