hassanbadru / starwarsapi

Hassan Badru

YouGov - Starwars API

Solution

Install Virtual Environment

With Python 3, run the following command to create a new virtual environment

python3 -m venv /path/to/[ENVIRONMENT NAME]

Activate the new virtual environment

source 'path/to/[ENVIRONMENT NAME]/bin/activate'

Navigate to project root folder

solution
    ├── yougov.py
    └── testdata/
    |   └── solution_result.json
    |   └── starship9.json
    └── output/
        └── characters.csv
        └── test.csv
    ├── README.md
    ├── requirements.txt
    ├── helpers.py
    ├── test_yougov.py
    ├── .git/
    └── .gitignore

Install Dependencies

Use pip to install the necessary dependencies with requirements.txt

pip install -r requirements.txt

Packages

• Requests
• PyTest

Run solution

python yougov.py

Output

$ results csv produced

This solution would produce the file characters.csv and add this file to output folder within the root directory. output folder is created if it doesn't exist.

Testing

To run test:

py.test -vv

Sample Test output

platform darwin -- Python 3.7.3, pytest-5.3.1, py-1.8.0, pluggy-0.13.1 -- /path/to/yougovenv/bin/python3
cachedir: .pytest_cache
rootdir: /path/to/solution
collected 6 items                                                                                                                                                                   

test_yougov.py::test_float_conv PASSED                                                                                                                                        [ 16%]
test_yougov.py::test_endpoint PASSED                                                                                                                                          [ 33%]
test_yougov.py::test_get_csv PASSED                                                                                                                                           [ 50%]
test_yougov.py::test_species PASSED                                                                                                                                           [ 66%]
test_yougov.py::test_send_csv PASSED                                                                                                                                          [ 83%]
test_yougov.py::test_solution PASSED                                                                                                                                          [100%]

================================================================================ 5 passed in 25.03s =================================================================================

or simply run pytest

Functionality

• Finds characters who appear in the most Star Wars films
• Sorts top ten characters by height in descending order
• Produces a CSV with the following columns: name, species, height, appearances
• Sends the CSV to httpbin.org

Design & Approach

• Traverse recursively to extract characters, starting from the endpoint's first page
• Compute appearances, height and finds species details for each character
• Create table / dictionary of name, species, height and appearances for each character
• Sort list of characters in descending order of appearance and slice to extract the top 10
• Take top 10 most appearances and sorts by height (tallest to shortest)
• Store as name, species, height, appearances values as fields / records in a CSV file
• Create a POST request to send CSV file

Custom Modules

• fetch_url() - extracts data from endpoint
• get_species() - gets name of species from endpoint
• get_characters() - fetches all the characters from all endpoint pages
• string_to_float() - converts any numeric string to float
• find_characters() - produces list of solution after sorting by height
• produce_csv() - produces csv of the format 'name, species, height, appearances'
• send_csv - sends csv using POST to httpbin

Assumptions

• 0.0 float for unknown heights
• N/A for no species data