cbbd 1.1.0a1__tar.gz

cbbd-1.1.0a1/PKG-INFO

@@ -0,0 +1,24 @@
+Metadata-Version: 2.2
+Name: cbbd
+Version: 1.1.0a1
+Summary: College Basketball Data API
+Home-page: https://github.com/CFBD/cbbd-python
+Author-email: admin@collegefootballdata.com
+License: MIT
+Keywords: OpenAPI,OpenAPI-Generator,College Basketball Data API
+Description-Content-Type: text/markdown
+Requires-Dist: urllib3<3.0.0,>=1.25.3
+Requires-Dist: python-dateutil
+Requires-Dist: pydantic<2,>=1.10.5
+Requires-Dist: aenum
+Dynamic: author-email
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: requires-dist
+Dynamic: summary
+
+    This API is in limited Beta for Patreon subscribers. It may have bugs and is subject to changes. API keys can be acquired from the CollegeFootballData.com website.
+    

cbbd-1.1.0a1/README.md

@@ -0,0 +1,136 @@
+# cbbd
+This API is in limited Beta for Patreon subscribers. It may have bugs and is subject to changes. API keys can be acquired from the CollegeFootballData.com website.
+
+This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
+
+- API version: 1.1.0
+- Package version: 1.1.0a1
+- Generator version: 7.11.0
+- Build package: org.openapitools.codegen.languages.PythonPydanticV1ClientCodegen
+
+## Requirements.
+
+Python 3.7+
+
+## Installation & Usage
+### pip install
+
+```sh
+pip install cbbd@1.1.0a1
+```
+(you may need to run `pip` with root permission: `sudo pip install cbbd@1.1.0a1`)
+
+Then import the package:
+```python
+import cbbd
+```
+
+## Getting Started
+
+Please follow the [installation procedure](#installation--usage) and then run the following:
+
+```python
+
+import time
+import cbbd
+from cbbd.rest import ApiException
+from pprint import pprint
+
+# Defining the host is optional and defaults to https://api.collegebasketballdata.com
+# See configuration.py for a list of all supported configuration parameters.
+configuration = cbbd.Configuration(
+    host = "https://api.collegebasketballdata.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.
+
+# Configure Bearer authorization: apiKey
+configuration = cbbd.Configuration(
+    access_token = os.environ["BEARER_TOKEN"]
+)
+
+
+# Enter a context with an instance of the API client
+with cbbd.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = cbbd.ConferencesApi(api_client)
+
+    try:
+        api_response = api_instance.get_conferences()
+        print("The response of ConferencesApi->get_conferences:\n")
+        pprint(api_response)
+    except ApiException as e:
+        print("Exception when calling ConferencesApi->get_conferences: %s\n" % e)
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *https://api.collegebasketballdata.com*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*ConferencesApi* | [**get_conferences**](docs/ConferencesApi.md#get_conferences) | **GET** /conferences | 
+*GamesApi* | [**get_broadcasts**](docs/GamesApi.md#get_broadcasts) | **GET** /games/media | 
+*GamesApi* | [**get_game_players**](docs/GamesApi.md#get_game_players) | **GET** /games/players | 
+*GamesApi* | [**get_game_teams**](docs/GamesApi.md#get_game_teams) | **GET** /games/teams | 
+*GamesApi* | [**get_games**](docs/GamesApi.md#get_games) | **GET** /games | 
+*PlaysApi* | [**get_play_types**](docs/PlaysApi.md#get_play_types) | **GET** /plays/types | 
+*PlaysApi* | [**get_plays**](docs/PlaysApi.md#get_plays) | **GET** /plays/game/{gameId} | 
+*PlaysApi* | [**get_plays_by_date**](docs/PlaysApi.md#get_plays_by_date) | **GET** /plays/date | 
+*PlaysApi* | [**get_plays_by_player_id**](docs/PlaysApi.md#get_plays_by_player_id) | **GET** /plays/player/{playerId} | 
+*PlaysApi* | [**get_plays_by_team**](docs/PlaysApi.md#get_plays_by_team) | **GET** /plays/team | 
+*StatsApi* | [**get_player_season_stats**](docs/StatsApi.md#get_player_season_stats) | **GET** /stats/player/season | 
+*StatsApi* | [**get_team_season_stats**](docs/StatsApi.md#get_team_season_stats) | **GET** /stats/team/season | 
+*TeamsApi* | [**get_teams**](docs/TeamsApi.md#get_teams) | **GET** /teams | 
+*VenuesApi* | [**get_venues**](docs/VenuesApi.md#get_venues) | **GET** /venues | 
+
+
+## Documentation For Models
+
+ - [ConferenceInfo](docs/ConferenceInfo.md)
+ - [GameBoxScorePlayers](docs/GameBoxScorePlayers.md)
+ - [GameBoxScorePlayersPlayersInner](docs/GameBoxScorePlayersPlayersInner.md)
+ - [GameBoxScoreTeam](docs/GameBoxScoreTeam.md)
+ - [GameBoxScoreTeamStats](docs/GameBoxScoreTeamStats.md)
+ - [GameBoxScoreTeamStatsPoints](docs/GameBoxScoreTeamStatsPoints.md)
+ - [GameInfo](docs/GameInfo.md)
+ - [GameMediaInfo](docs/GameMediaInfo.md)
+ - [GameMediaInfoBroadcastsInner](docs/GameMediaInfoBroadcastsInner.md)
+ - [GameStatus](docs/GameStatus.md)
+ - [PlayInfo](docs/PlayInfo.md)
+ - [PlayInfoParticipantsInner](docs/PlayInfoParticipantsInner.md)
+ - [PlayTypeInfo](docs/PlayTypeInfo.md)
+ - [PlayerSeasonStats](docs/PlayerSeasonStats.md)
+ - [SeasonType](docs/SeasonType.md)
+ - [TeamInfo](docs/TeamInfo.md)
+ - [TeamSeasonStats](docs/TeamSeasonStats.md)
+ - [TeamSeasonUnitStats](docs/TeamSeasonUnitStats.md)
+ - [TeamSeasonUnitStatsFieldGoals](docs/TeamSeasonUnitStatsFieldGoals.md)
+ - [TeamSeasonUnitStatsFouls](docs/TeamSeasonUnitStatsFouls.md)
+ - [TeamSeasonUnitStatsFourFactors](docs/TeamSeasonUnitStatsFourFactors.md)
+ - [TeamSeasonUnitStatsPoints](docs/TeamSeasonUnitStatsPoints.md)
+ - [TeamSeasonUnitStatsRebounds](docs/TeamSeasonUnitStatsRebounds.md)
+ - [TeamSeasonUnitStatsTurnovers](docs/TeamSeasonUnitStatsTurnovers.md)
+ - [VenueInfo](docs/VenueInfo.md)
+
+
+<a id="documentation-for-authorization"></a>
+## Documentation For Authorization
+
+
+Authentication schemes defined for the API:
+<a id="apiKey"></a>
+### apiKey
+
+- **Type**: Bearer authentication
+
+
+## Author
+
+admin@collegefootballdata.com
+
+

cbbd-1.1.0a1/cbbd/__init__.py

@@ -0,0 +1,64 @@
+# coding: utf-8
+
+# flake8: noqa
+
+"""
+    College Basketball Data API
+
+    This API is in limited Beta for Patreon subscribers. It may have bugs and is subject to changes. API keys can be acquired from the CollegeFootballData.com website.
+
+    The version of the OpenAPI document: 1.1.0
+    Contact: admin@collegefootballdata.com
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+__version__ = "1.1.0a1"
+
+# import apis into sdk package
+from cbbd.api.conferences_api import ConferencesApi
+from cbbd.api.games_api import GamesApi
+from cbbd.api.plays_api import PlaysApi
+from cbbd.api.stats_api import StatsApi
+from cbbd.api.teams_api import TeamsApi
+from cbbd.api.venues_api import VenuesApi
+
+# import ApiClient
+from cbbd.api_response import ApiResponse
+from cbbd.api_client import ApiClient
+from cbbd.configuration import Configuration
+from cbbd.exceptions import OpenApiException
+from cbbd.exceptions import ApiTypeError
+from cbbd.exceptions import ApiValueError
+from cbbd.exceptions import ApiKeyError
+from cbbd.exceptions import ApiAttributeError
+from cbbd.exceptions import ApiException
+
+# import models into sdk package
+from cbbd.models.conference_info import ConferenceInfo
+from cbbd.models.game_box_score_players import GameBoxScorePlayers
+from cbbd.models.game_box_score_players_players_inner import GameBoxScorePlayersPlayersInner
+from cbbd.models.game_box_score_team import GameBoxScoreTeam
+from cbbd.models.game_box_score_team_stats import GameBoxScoreTeamStats
+from cbbd.models.game_box_score_team_stats_points import GameBoxScoreTeamStatsPoints
+from cbbd.models.game_info import GameInfo
+from cbbd.models.game_media_info import GameMediaInfo
+from cbbd.models.game_media_info_broadcasts_inner import GameMediaInfoBroadcastsInner
+from cbbd.models.game_status import GameStatus
+from cbbd.models.play_info import PlayInfo
+from cbbd.models.play_info_participants_inner import PlayInfoParticipantsInner
+from cbbd.models.play_type_info import PlayTypeInfo
+from cbbd.models.player_season_stats import PlayerSeasonStats
+from cbbd.models.season_type import SeasonType
+from cbbd.models.team_info import TeamInfo
+from cbbd.models.team_season_stats import TeamSeasonStats
+from cbbd.models.team_season_unit_stats import TeamSeasonUnitStats
+from cbbd.models.team_season_unit_stats_field_goals import TeamSeasonUnitStatsFieldGoals
+from cbbd.models.team_season_unit_stats_fouls import TeamSeasonUnitStatsFouls
+from cbbd.models.team_season_unit_stats_four_factors import TeamSeasonUnitStatsFourFactors
+from cbbd.models.team_season_unit_stats_points import TeamSeasonUnitStatsPoints
+from cbbd.models.team_season_unit_stats_rebounds import TeamSeasonUnitStatsRebounds
+from cbbd.models.team_season_unit_stats_turnovers import TeamSeasonUnitStatsTurnovers
+from cbbd.models.venue_info import VenueInfo

cbbd-1.1.0a1/cbbd/api/__init__.py

@@ -0,0 +1,10 @@
+# flake8: noqa
+
+# import apis into api package
+from cbbd.api.conferences_api import ConferencesApi
+from cbbd.api.games_api import GamesApi
+from cbbd.api.plays_api import PlaysApi
+from cbbd.api.stats_api import StatsApi
+from cbbd.api.teams_api import TeamsApi
+from cbbd.api.venues_api import VenuesApi
+

cbbd-1.1.0a1/cbbd/api/conferences_api.py

@@ -0,0 +1,176 @@
+# coding: utf-8
+
+"""
+    College Basketball Data API
+
+    This API is in limited Beta for Patreon subscribers. It may have bugs and is subject to changes. API keys can be acquired from the CollegeFootballData.com website.
+
+    The version of the OpenAPI document: 1.1.0
+    Contact: admin@collegefootballdata.com
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+import re  # noqa: F401
+import io
+import warnings
+
+from pydantic import validate_arguments, ValidationError
+
+from typing import List
+
+from cbbd.models.conference_info import ConferenceInfo
+
+from cbbd.api_client import ApiClient
+from cbbd.api_response import ApiResponse
+from cbbd.exceptions import (  # noqa: F401
+    ApiTypeError,
+    ApiValueError
+)
+
+
+class ConferencesApi:
+    """NOTE: This class is auto generated by OpenAPI Generator
+    Ref: https://openapi-generator.tech
+
+    Do not edit the class manually.
+    """
+
+    def __init__(self, api_client=None) -> None:
+        if api_client is None:
+            api_client = ApiClient.get_default()
+        self.api_client = api_client
+
+    @validate_arguments
+    def get_conferences(self, **kwargs) -> List[ConferenceInfo]:  # noqa: E501
+        """get_conferences  # noqa: E501
+
+        Retrieves list of available conferences  # noqa: E501
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+
+        >>> thread = api.get_conferences(async_req=True)
+        >>> result = thread.get()
+
+        :param async_req: Whether to execute the request asynchronously.
+        :type async_req: bool, optional
+        :param _request_timeout: timeout setting for this request.
+               If one number provided, it will be total request
+               timeout. It can also be a pair (tuple) of
+               (connection, read) timeouts.
+        :return: Returns the result object.
+                 If the method is called asynchronously,
+                 returns the request thread.
+        :rtype: List[ConferenceInfo]
+        """
+        kwargs['_return_http_data_only'] = True
+        if '_preload_content' in kwargs:
+            message = "Error! Please call the get_conferences_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data"  # noqa: E501
+            raise ValueError(message)
+        return self.get_conferences_with_http_info(**kwargs)  # noqa: E501
+
+    @validate_arguments
+    def get_conferences_with_http_info(self, **kwargs) -> ApiResponse:  # noqa: E501
+        """get_conferences  # noqa: E501
+
+        Retrieves list of available conferences  # noqa: E501
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+
+        >>> thread = api.get_conferences_with_http_info(async_req=True)
+        >>> result = thread.get()
+
+        :param async_req: Whether to execute the request asynchronously.
+        :type async_req: bool, optional
+        :param _preload_content: if False, the ApiResponse.data will
+                                 be set to none and raw_data will store the
+                                 HTTP response body without reading/decoding.
+                                 Default is True.
+        :type _preload_content: bool, optional
+        :param _return_http_data_only: response data instead of ApiResponse
+                                       object with status code, headers, etc
+        :type _return_http_data_only: bool, optional
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the authentication
+                              in the spec for a single request.
+        :type _request_auth: dict, optional
+        :type _content_type: string, optional: force content-type for the request
+        :return: Returns the result object.
+                 If the method is called asynchronously,
+                 returns the request thread.
+        :rtype: tuple(List[ConferenceInfo], status_code(int), headers(HTTPHeaderDict))
+        """
+
+        _params = locals()
+
+        _all_params = [
+        ]
+        _all_params.extend(
+            [
+                'async_req',
+                '_return_http_data_only',
+                '_preload_content',
+                '_request_timeout',
+                '_request_auth',
+                '_content_type',
+                '_headers'
+            ]
+        )
+
+        # validate the arguments
+        for _key, _val in _params['kwargs'].items():
+            if _key not in _all_params:
+                raise ApiTypeError(
+                    "Got an unexpected keyword argument '%s'"
+                    " to method get_conferences" % _key
+                )
+            _params[_key] = _val
+        del _params['kwargs']
+
+        _collection_formats = {}
+
+        # process the path parameters
+        _path_params = {}
+
+        # process the query parameters
+        _query_params = []
+        # process the header parameters
+        _header_params = dict(_params.get('_headers', {}))
+        # process the form parameters
+        _form_params = []
+        _files = {}
+        # process the body parameter
+        _body_params = None
+        # set the HTTP header `Accept`
+        _header_params['Accept'] = self.api_client.select_header_accept(
+            ['application/json'])  # noqa: E501
+
+        # authentication setting
+        _auth_settings = ['apiKey']  # noqa: E501
+
+        _response_types_map = {
+            '200': "List[ConferenceInfo]",
+        }
+
+        return self.api_client.call_api(
+            '/conferences', 'GET',
+            _path_params,
+            _query_params,
+            _header_params,
+            body=_body_params,
+            post_params=_form_params,
+            files=_files,
+            response_types_map=_response_types_map,
+            auth_settings=_auth_settings,
+            async_req=_params.get('async_req'),
+            _return_http_data_only=_params.get('_return_http_data_only'),  # noqa: E501
+            _preload_content=_params.get('_preload_content', True),
+            _request_timeout=_params.get('_request_timeout'),
+            collection_formats=_collection_formats,
+            _request_auth=_params.get('_request_auth'))