type-hints

Problem

We could improve the readability / experience reading through the library source code if there were module level docstrings.

Suggested solution

All python modules should include a docstring explaining

Just fix tests to use Factory instead of old style

We get the return annotation for free, so we should allow users to do something with it.

https://docs.python.org/3/reference/datamodel.html#object.__bytes__

It seems that the typing module doesn't flatten nested literal type definitions, so the following does not currently work:

SuccessStatus = Literal[200, 201, 204]
ClientError = Literal[404, 401, 403, 409, 400]
ServerError = Literal[500, 504, 503]

@dataclass
class HttpResponse(JsonSchemaMixin):
    status: Literal[SuccessStatus, ClientError, ServerError]
    ...