sportsfoundry

Stable customer contract over SportsFoundry canonical sports data. Supplier, routing, rights and operator implementation details are intentionally excluded.

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

• API version: 1.0.0
• Package version: 0.1.0a1
• Generator version: 7.24.0
• Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit https://sportsfoundry.app

Requirements.

Python 3.10+

Installation & Usage

pip install

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

pip install git+https://github.com/SportsFoundry/sdks.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/SportsFoundry/sdks.git)

Then import the package:

import sportsfoundry

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 sportsfoundry

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import sportsfoundry
from sportsfoundry.rest import ApiException
from pprint import pprint

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

# 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 API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'


# Enter a context with an instance of the API client
with sportsfoundry.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = sportsfoundry.DefaultApi(api_client)
    competition_edition_id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID |  (optional)
    team_id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID |  (optional)
    status = sportsfoundry.EventStatus() # EventStatus |  (optional)
    var_from = '2013-10-20T19:20:30+01:00' # datetime |  (optional)
    to = '2013-10-20T19:20:30+01:00' # datetime |  (optional)
    cursor = 'cursor_example' # str |  (optional)
    limit = 50 # int |  (optional) (default to 50)

    try:
        api_response = api_instance.find_events(competition_edition_id=competition_edition_id, team_id=team_id, status=status, var_from=var_from, to=to, cursor=cursor, limit=limit)
        print("The response of DefaultApi->find_events:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling DefaultApi->find_events: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://sportsfoundry.app

Documentation For Models

• Competition
• CompetitionCollection
• Edition
• EditionCollection
• Event
• EventPage
• EventParticipant
• EventScore
• EventStatus
• MembershipResource
• PlayerResource
• Problem
• SearchCollection
• SearchResource
• Sport
• SportCollection
• SquadPlayerResource
• SquadResource
• StandingResource
• StandingsResource
• Team
• TeamCollection
• Venue
• VenueCollection

Documentation For Authorization

Authentication schemes defined for the API:

ApiKeyAuth

• Type: API key
• API key parameter name: X-API-Key
• Location: HTTP header

Author