Metadata-Version: 2.4
Name: sportsfoundry
Version: 0.1.0a1
Summary: SportsFoundry Developer API
Home-page: https://github.com/SportsFoundry/sdks
Author: SportsFoundry
License: Apache-2.0
Project-URL: Repository, https://github.com/SportsFoundry/sdks
Keywords: OpenAPI,OpenAPI-Generator,SportsFoundry Developer API
Requires-Python: >=3.9
Description-Content-Type: text/markdown
Requires-Dist: urllib3<3.0.0,>=2.6.3
Requires-Dist: python-dateutil>=2.8.2
Requires-Dist: pydantic>=2.11
Requires-Dist: typing-extensions>=4.7.1
Dynamic: home-page

# 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](https://openapi-generator.tech) 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](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:

```sh
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:
```python
import sportsfoundry
```

### Setuptools

Install via [Setuptools](http://pypi.python.org/pypi/setuptools).

```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)

Then import the package:
```python
import sportsfoundry
```

### Tests

Execute `pytest` to run the tests.

## Getting Started

Please follow the [installation procedure](#installation--usage) and then run the following:

```python

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*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*DefaultApi* | [**find_events**](docs/DefaultApi.md#find_events) | **GET** /api/v1/events | 
*DefaultApi* | [**get_competition**](docs/DefaultApi.md#get_competition) | **GET** /api/v1/competitions/{competitionId} | 
*DefaultApi* | [**get_current_squad**](docs/DefaultApi.md#get_current_squad) | **GET** /api/v1/teams/{teamId}/squad | 
*DefaultApi* | [**get_edition**](docs/DefaultApi.md#get_edition) | **GET** /api/v1/editions/{editionId} | 
*DefaultApi* | [**get_event**](docs/DefaultApi.md#get_event) | **GET** /api/v1/events/{eventId} | 
*DefaultApi* | [**get_player**](docs/DefaultApi.md#get_player) | **GET** /api/v1/players/{playerId} | 
*DefaultApi* | [**get_sport**](docs/DefaultApi.md#get_sport) | **GET** /api/v1/sports/{sportId} | 
*DefaultApi* | [**get_standings**](docs/DefaultApi.md#get_standings) | **GET** /api/v1/editions/{editionId}/standings | 
*DefaultApi* | [**get_team**](docs/DefaultApi.md#get_team) | **GET** /api/v1/teams/{teamId} | 
*DefaultApi* | [**get_venue**](docs/DefaultApi.md#get_venue) | **GET** /api/v1/venues/{venueId} | 
*DefaultApi* | [**list_competitions**](docs/DefaultApi.md#list_competitions) | **GET** /api/v1/competitions | 
*DefaultApi* | [**list_editions**](docs/DefaultApi.md#list_editions) | **GET** /api/v1/editions | 
*DefaultApi* | [**list_sports**](docs/DefaultApi.md#list_sports) | **GET** /api/v1/sports | 
*DefaultApi* | [**list_teams**](docs/DefaultApi.md#list_teams) | **GET** /api/v1/teams | 
*DefaultApi* | [**list_venues**](docs/DefaultApi.md#list_venues) | **GET** /api/v1/venues | 
*DefaultApi* | [**search_football**](docs/DefaultApi.md#search_football) | **GET** /api/v1/search | 


## Documentation For Models

 - [Competition](docs/Competition.md)
 - [CompetitionCollection](docs/CompetitionCollection.md)
 - [Edition](docs/Edition.md)
 - [EditionCollection](docs/EditionCollection.md)
 - [Event](docs/Event.md)
 - [EventPage](docs/EventPage.md)
 - [EventParticipant](docs/EventParticipant.md)
 - [EventScore](docs/EventScore.md)
 - [EventStatus](docs/EventStatus.md)
 - [MembershipResource](docs/MembershipResource.md)
 - [PlayerResource](docs/PlayerResource.md)
 - [Problem](docs/Problem.md)
 - [SearchCollection](docs/SearchCollection.md)
 - [SearchResource](docs/SearchResource.md)
 - [Sport](docs/Sport.md)
 - [SportCollection](docs/SportCollection.md)
 - [SquadPlayerResource](docs/SquadPlayerResource.md)
 - [SquadResource](docs/SquadResource.md)
 - [StandingResource](docs/StandingResource.md)
 - [StandingsResource](docs/StandingsResource.md)
 - [Team](docs/Team.md)
 - [TeamCollection](docs/TeamCollection.md)
 - [Venue](docs/Venue.md)
 - [VenueCollection](docs/VenueCollection.md)


<a id="documentation-for-authorization"></a>
## Documentation For Authorization


Authentication schemes defined for the API:
<a id="ApiKeyAuth"></a>
### ApiKeyAuth

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


## Author




