Plat 245

[gianchub]

@mattbennett

This creates the library as agreed.

jira task

[mattbennett]

wheelhouse, config and .env.* are all student.com specific conventions that we should leave out of here

[mattbennett]

Probably want to add docs/build too

[gianchub]

Done.

[gianchub]

All comments addressed.

[mattbennett]

I don't think it's helpful to show any pytest boilerplate in these "how to use it" docs. The important parts are

>>> result = compare(uri_left, uri_right)
>>> result.is_match
    True

and

>>> result = compare(uri_left, uri_right)
>>> result.is_match
    False

>>> result.dump_errors()
    {
        ...
    }

Everything else is unnecessary and risks causing confusion. People will wonder what new_db_left and new_db_right are, and whether pytest is a requirement.

[gianchub]

Done.

[mattbennett]

This is very nice. Just a few changes to make please.

[gianchub]

Thank you, all comments addressed.

[mattbennett]

👍 awesome