Adding synchronous API functionality

[kieran-smith]

Added a SyncCaicClient class as described in the documentation . I copied the CaicClient class and modified it to enable synchronous calls. Added requests to the dependencies list in pyproject.toml, to the [packages] list in Pipfile, and imported it in client.py. Modified the original usage demo to utilize the SyncCaicClient class and successfully got all of the original calls to work:

import datetime
from caic_python.client import SyncCaicClient
from caic_python.enums import (
    ObsTypes, ReportsSearchCrackObs, BCZoneTitles
)
from caic_python.utils import find_classic_id

# ISO 8601 format makes avy_obs calls happy
now = datetime.datetime.now()
two_weeks_ago = (now - datetime.timedelta(days=14))
now = now.strftime("%Y-%m-%dT%H:%M:%SZ")
two_weeks_ago = two_weeks_ago.strftime("%Y-%m-%dT%H:%M:%SZ")

# Create a synchronous client
client = SyncCaicClient()

# For every D1 avalanche in the last 2 weeks, print some detials.
avy_observations = client.avy_obs(two_weeks_ago, now)
for avy in avy_observations:
    if avy.destructive_size is not None:
        if avy.destructive_size.value == "D1":
            print(f"Aspect: {avy.aspect}")
            print(f"Elevation: {avy.elevation_feet}")
            print(f"Area: {avy.area}")
            if not avy.avalanche_detail is None:
                print(f"Classic ID: {avy.avalanche_detail.classic_id}")
            print(f"Field Report: {avy.observation_report.id}")

field_reports = client.field_reports(two_weeks_ago, now)

# For every recent field report that has
# multiple avalanches, download any attached images.
# for report in field_reports:
#     if report.avalanche_observations_count > 1:
#         if report.assets and len(report.assets) > 1:
#             for asset in assets:
#                 # There's also a VIDEO_ASSET type
#                 if asset.type == ObsTypes.IMAGE_ASSET.value:
#                     # HTTP GET request for ``asset.full_url``

# If a recent field report has a weather
# observation, print the recorded temperature.
for report in field_reports:
    if report.weather_observations_count >= 1:
        for weather_obs in report.weather_observations:
            print(f"Parent Field Report: {report.id}")
            print(f"Location: {weather_obs.location}")
            print(f"Temperature: {weather_obs.temperature}")



# Some more refined field reports searches.

# Show me all field reports from the Sawatch in
# Jan 2023 that reported shooting cracks.
jan_cracking_reports = client.field_reports(
    "2023-01-01 00:00:00",
    "2023-01-31 11:59:59",
    bc_zones=[BCZoneTitles.SAWATCH.name],
    cracking_obs=[ReportsSearchCrackObs.SHOOTING.name]
)

# Show me all field reports in 2022 where an avalanche
# was seen and the word "bluebird" appears in the report.
bluebird_avys = client.field_reports(
    "2022-01-01 00:00:00",
    "2022-12-31 11:59:59",
    query="bluebird",
    avy_seen=True,
)


# Show me all field reports in 2012 and
# map classic IDs to their new API UUID.
reports_2012 = client.field_reports(
    "2012-01-01 00:00:00",
    "2012-12-31 11:59:59",
)

id_map = {}
for report in reports_2012:
    classic_id = find_classic_id(report)
    print(f"The Classic ID for {report.id} is {classic_id}")