magdazawora/earlybird

Project to practise getting data from APIs, parsing json and xml + mailing

earlybird's Issues

send_emails should get all input via parameters

Move end formatting to a single file

Information should be passed between components in a computer-understandable format. Change from data structures to formatted text should happen at the very end of the processing pipeline.

In main.py we unnecessary fetch observations twice

get_observations returns a string, not a list of birds

get_emails leaks the file handler

Use with statement to automatically close the file:

with open('file', 'r') as opened_file:
    # do whatever is needed

Turn debug printouts into real unittests

In birds.py we should use requests instead of urrlib

check_must_have checks only for the first bird

Ideally, we can use a list comprehension:

def check_must_have(observations, must_have):
    return [b for b in must_have if b in observations]

Formatting should be done using templates

Instead of:

message = 'Subject: Time to do some bird-watching!\n'
message += 'Hi ' + name + '!\n\n'
message += 'Some interesting sighting have been recently noticed: '
message += observations + '\n'

use:

MESSAGE_TEMPLATE = '''
Subject: Time to do some bird-watching!
Hi {name}!

Some interesting sighting have been recently noticed:
{observations}

(...)
'''

message = MESSAGE_TEMPLATE.format(name='foo', observations='bar')