Days 55-57 Structured APIs with uplink

Remember the movie search service we discussed when we first worked with HTTP services? It's back and you're going to build a proper API client for it using uplink.

Day N: Application skeleton

Today is mostly watching the corresponding videos from the course. Be sure to watch the videos first. Then:

1. Create a new empty Python project with a virtual environment
2. Reminder: Virtual environments are created using the commend python3 -m venv .env (use python rather than python3 for the command on Windows).
3. Activate the environment:
   • macOS / Linux: . .env/bin/activate
   • Windows: .env/scripts/activate
4. Install uplink with pip
5. Create a program.py Python file and supporting api.py file
6. Import uplink inside the api.py, import api in program.py, and run program.py to make sure it's wall hanging together.

Day N+1: Model the API

Visit the movie search service: movieservice.talkpython.fm.

You'll see there are three RESTful operations.

Search movies
GET /api/search/{keyword}

Movies by director
GET /api/director/{director_name}

Movie by IMDB code
GET /api/movie/{imdb_number}

Your goal today will be to build an API client class in api.py.

1. Create a class (name it something like MovieSearchClient).
2. Indicate uplink.Consumer as the base class.
3. Add a __init__ method to pass https://movieservice.talkpython.fm/ as the base_url to the super class.
4. Add a method for each of the three HTTP endpoints

Recall that you define an endpoint method inside the class as:

class MyClass(uplink.Consumer):

    @uplink.get('/path/to/api/with/{data}')
    def call_api(data):
       pass
       
    # ...

Day N+2: Create the search app

Now that you have your API client, write a simple UI in program.py that uses your class. You might give the user a chance to search by any of the three endpoints and then display the results.

Time to share what you've accomplished!

Be sure to share your last couple of days work on Twitter or Facebook. Use the hashtag #100DaysOfCode.

Here are some examples to inspire you. Consider including @talkpython and @pybites in your tweets.

See a mistake in these instructions? Please submit a new issue or fix it and submit a PR.