Merge pull request #4 from PlayerData/3-add-example-for-querying-raw-data

feat: add raw data query examples

Author: elliotgPD

README.md

@@ -35,24 +35,39 @@ To request API credentials, please contact the PlayerData team at support@player
 
 ### Option 1: Use generated types with PlayerDataAPI
 
-Example usage of this option is provided in the `example_pydantic.py` file.
+Example usage of this option is provided in the `examples/pydantic/` folder.
 The basic flow is to create a PlayerDataAPI instance, build the query objects using the code-generated Pydantic models (generated by ariadne-codegen), and then call the run_queries method.
 
 To run an example of this option, you can use the following command:
 
 ```bash
-python example_pydantic.py
+python examples/pydantic/sessions_query.py
 ```
 
+To run this you will need to set the following environment variables or hardcode them in the file:
+```bash
+export CLIENT_ID=your_client_id
+export CLIENT_SECRET=your_client_secret
+export CLUB_ID=your_club_id
+```
+
+
 ### Option 2: Use the GraphqlClient class directly
 
-Example usage of this option is provided in the `example_direct.py` file.
+Example usage of this option is provided in the `examples/direct/` folder.
 The basic flow is to create a GraphqlClient instance, build the query string, and then call the query method.
 
 To run an example of this option, you can use the following command:
 
 ```bash
-python example_direct.py
+python examples/direct/sessions_query.py
+```
+
+To run this you will need to set the following environment variables or hardcode them in the file:
+```bash
+export CLIENT_ID=your_client_id
+export CLIENT_SECRET=your_client_secret
+export CLUB_ID=your_club_id
 ```
 
 ## Authentication Types

example_direct.py examples/direct/raw_data_query.pyexample_direct.py renamed to examples/direct/raw_data_query.py

@@ -3,18 +3,26 @@
 from playerdatapy.gqlauth import AuthenticationType
 import asyncio
 from playerdatapy.constants import API_BASE_URL
+import os
 
-# Build out the query string.
-# Our GraphiQL Playground at https://app.playerdata.co.uk/api/graphiql/ is useful for building out and testing the query.
-CLIENT_ID = "your_client_id"
-CLIENT_SECRET = "your_client_secret"
+CLIENT_ID = os.environ.get("CLIENT_ID")
+CLIENT_SECRET = os.environ.get("CLIENT_SECRET")
+SESSION_ID = os.environ.get("SESSION_ID")
 
-example_query = """
-query Session($session_id: ID!) {
+# Build out the query string to get session participations and datafiles from a session.
+# Our GraphiQL Playground at https://app.playerdata.co.uk/api/graphiql/ is useful for building out and testing the query.
+session_query = """
+query GetSessionParticipations($session_id: ID!) {
     session(id: $session_id) {
-        id
-        startTime
-        endTime
+        sessionParticipations {
+            id
+            athlete {
+                name
+            }
+            datafiles {
+                url(format: json)
+            }
+        }
     }
 }
 """
@@ -31,14 +39,13 @@ async def main(session_id: str):
         headers={"Authorization": f"Bearer {auth._get_authentication_token()}"},
     )
     response = await client.execute(
-        query=example_query,
+        query=session_query,
         variables={"session_id": session_id},
     )
     result = client.get_data(response)
-    return result["session"]
+    return result
 
 
 if __name__ == "__main__":
-    session_id = "an_example_session_id"
-    result = asyncio.run(main(session_id))
+    result = asyncio.run(main(SESSION_ID))
     print(result)

examples/direct/sessions_query.py

@@ -0,0 +1,51 @@
+from playerdatapy.gqlauth import GraphqlAuth
+from playerdatapy.gqlclient import Client
+from playerdatapy.gqlauth import AuthenticationType
+import asyncio
+from playerdatapy.constants import API_BASE_URL
+import os
+from datetime import datetime, timedelta
+
+CLIENT_ID = os.environ.get("CLIENT_ID")
+CLIENT_SECRET = os.environ.get("CLIENT_SECRET")
+CLUB_ID = os.environ.get("CLUB_ID")
+
+
+# Build out the query string to get session details.
+# Our GraphiQL Playground at https://app.playerdata.co.uk/api/graphiql/ is useful for building out and testing the query.
+example_query = """
+query($clubIdEq:ID!,$startTimeGteq:ISO8601DateTime,$endTimeLteq:ISO8601DateTime){
+  sessions(filter: {clubIdEq:$clubIdEq, startTimeGteq:$startTimeGteq, endTimeLteq:$endTimeLteq}){
+    id
+    startTime
+    endTime
+  }
+}
+"""
+
+
+async def main():
+    auth = GraphqlAuth(
+        client_id=CLIENT_ID,
+        client_secret=CLIENT_SECRET,
+        type=AuthenticationType.CLIENT_CREDENTIALS_FLOW,
+    )
+    client = Client(
+        url=f"{API_BASE_URL}/api/graphql",
+        headers={"Authorization": f"Bearer {auth._get_authentication_token()}"},
+    )
+    startTimeGteq = (datetime.now() - timedelta(days=30)).isoformat()
+    endTimeLteq = datetime.now().isoformat()
+    variables = {
+        "clubIdEq": CLUB_ID,
+        "startTimeGteq": startTimeGteq,
+        "endTimeLteq": endTimeLteq,
+    }
+    response = await client.execute(query=example_query, variables=variables)
+    result = client.get_data(response)
+    return result["sessions"]
+
+
+if __name__ == "__main__":
+    result = asyncio.run(main())
+    print(result)

examples/pydantic/raw_data_query.py

@@ -0,0 +1,41 @@
+import asyncio
+
+from playerdatapy.playerdata_api import PlayerDataAPI
+from playerdatapy.custom_queries import Query
+from playerdatapy.custom_fields import (
+    SessionInterface,
+    SessionParticipationInterface,
+    AthleteFields,
+    EdgeDataFileFields,
+)
+from playerdatapy.enums import DatafileFormat
+from playerdatapy.gqlauth import AuthenticationType
+import os
+
+CLIENT_ID = os.environ.get("CLIENT_ID")
+CLIENT_SECRET = os.environ.get("CLIENT_SECRET")
+SESSION_ID = os.environ.get("SESSION_ID")
+
+# Create a PlayerDataAPI instance.
+api = PlayerDataAPI(
+    client_id=CLIENT_ID,
+    client_secret=CLIENT_SECRET,
+    authentication_type=AuthenticationType.CLIENT_CREDENTIALS_FLOW,
+)
+
+# Build out the query to get session participations and datafiles from a session.
+session_query = Query.session(id=SESSION_ID).fields(
+    SessionInterface.session_participations().fields(
+        SessionParticipationInterface.id,
+        SessionParticipationInterface.athlete().fields(
+            AthleteFields.name,
+        ),
+        SessionParticipationInterface.datafiles().fields(
+            EdgeDataFileFields.url(format=DatafileFormat.json),
+        ),
+    ),
+)
+
+# Run the query.
+response = asyncio.run(api.run_queries("GetSessionParticipations", session_query))
+print(response)

example_pydantic.py examples/pydantic/sessions_query.pyexample_pydantic.py renamed to examples/pydantic/sessions_query.py

@@ -3,13 +3,14 @@
 
 from playerdatapy.playerdata_api import PlayerDataAPI
 from playerdatapy.custom_queries import Query
-from playerdatapy.custom_fields import SportDefinitionFields, SessionInterface
+from playerdatapy.custom_fields import SessionInterface
 from playerdatapy.input_types import SessionsSessionFilter
 from playerdatapy.gqlauth import AuthenticationType
+import os
 
-CLIENT_ID = "your_client_id"
-CLIENT_SECRET = "your_client_secret"
-CLUB_ID = "your_club_id"
+CLIENT_ID = os.environ.get("CLIENT_ID")
+CLIENT_SECRET = os.environ.get("CLIENT_SECRET")
+CLUB_ID = os.environ.get("CLUB_ID")
 
 # Create a PlayerDataAPI instance.
 api = PlayerDataAPI(
@@ -19,13 +20,6 @@
 )
 
 # Build out the query objects.
-sports_query = Query.sports().fields(
-    SportDefinitionFields.id,
-    SportDefinitionFields.name,
-    SportDefinitionFields.is_indoor,
-    SportDefinitionFields.has_pitch_definition,
-)
-
 sessions_query = Query.sessions(
     filter=SessionsSessionFilter(
         clubIdEq=CLUB_ID,
@@ -38,6 +32,6 @@
     SessionInterface.end_time,
 )
 
-# Run the queries.
-response = asyncio.run(api.run_queries("sports", sports_query, sessions_query))
+# Run the query .
+response = asyncio.run(api.run_queries("Sessions", sessions_query))
 print(response)