Python API Client Exercise

This is a basic fake API Client for developers to interact with, somewhat simulating real-life behaviours.

---

• Python API Client Exercise
  • Exercise
  • Repository
    • API Client

---

Exercise

You will need to modify the solution.py file ONLY

1. Print each individual APIObject from the response data, and a summary for each endpoint

   For this step, see the raw output produced by the example code above (which logs each page of result objects), and then alter it to log something nicer for individual object.

   Also, log any summaries that you might care about after all items have been returned from your request.

2. Handle possible errors

   The fake API could randomly throw an exception. To discover this, first re-run your current solution with a time range of at least 6-12 months. You should handle the error by logging it and then allowing the program to continue execution

3. (extension) Write output to file.

   After the error handling is fully implemented and tested, alter your solution so that the output from each endpoint is written to its own file on disk. You may choose any output format that you deem appropriate, but either CSV or NDJSON (newline-delimited JSON) are definitely preferred.

---

Repository

This repository aims to mimick the experience of using an existing pip-packaged client to access data via an API.

This repository contains the code for both the "public-facing" client library, and also the "private/internal" API implementation.

Only the methods in the "public-facing" client code (solution.py) needs to be modified for this exercise. You may examine the API implementation if you wish, but it has been written in a style that is intended to slow down comprehension and reading, and is not required to complete the exercise.

The API client is comprised of two modules/files:

• python_api_client_exercise/api.py - "public-facing" client library
• python_api_client_exercise/underbelly.py - "private/internal" API implementation

---

API Client

• There are three endpoints that return different items, in different amounts (these can also be found in the variable ENDPOINTS inside api.py):

  • lists, customers, endpoints

• There is a single method fetch that yields pages of api results. This is the only method that you have to interact with.

  # The available endpoints can found via the api.ENDPOINTS variable
  class Client:
      def fetch(self, endpoint: str, start_date: datetime, end_date: datetime) -> Iterator[List[APIObject]]:

  You may call other methods in this repo directly if you choose, but the aim of this exercise is to implement best-practice usage of the fetch method.

• This method yields a paginated response of (aka "pages" of) APIObject objects, which contain 3 fields:

  class APIObject:
      created_at: datetime
      identifier: str
      data:       dict