Changelog¶
All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog, and this project adheres to the Semantic Versioning scheme.
0.4.1 - 2018-3-10¶
Fixed¶
- Enforce method-level decorators override class-level decorators when they conflict.
0.4.0 - 2018-2-10¶
Added¶
- Support for Basic Authentication.
- The
response_handler
decorator for defining custom response handlers. - The
error_handler
decorator for defining custom error handlers. - The
inject
decorator for injecting other kinds of middleware. - The
Consumer._inject
method for adding middleware to a consumer instance. - Support for annotating constructor arguments of a
Consumer
subclass with built-in function annotations likeQuery
andHeader
.
0.3.0 - 2018-1-09¶
Added¶
- HTTP HEAD request decorator by @brandonio21.
- Support for returning deserialized response objects using
marshmallow
schemas. - Constructor parameter for
Query
andQueryMap
to support already encoded URL parameters. - Support for using
requests.Session
andaiohttp.ClientSession
instances with theclient
parameter of theConsumer
constructor.
Changed¶
aiohttp
andtwisted
are now optional dependencies/extras.
Fixed¶
- Fix for calling a request method with
super
, by @brandonio21. - Fix issue where method decorators would incorrectly decorate inherited request methods.
0.2.0 - 2017-11-03¶
Added¶
- The class
uplink.Consumer
by @itstehkman. Consumer classes should inherit this base. class, and creating consumer instances happens through instantiation. - Support for
asyncio
for Python 3.4 and above. - Support for
twisted
for all supported Python versions.
Changed¶
- BREAKING: Invoking a consumer method now builds and executes the request,
removing the extra step of calling the
execute
method.
Deprecated¶
- Building consumer instances with
uplink.build
. Instead, Consumer classes should inherituplink.Consumer
.
Fixed¶
- Header link for version 0.1.1 in changelog.
0.1.1 - 2017-10-21¶
Added¶
- Contribution guide,
CONTRIBUTING.rst
. - “Contributing” Section in README.rst that links to contribution guide.
AUTHORS.rst
file for listing project contributors.- Adopt Contributor Covenant Code of Conduct.
Changed¶
- Replaced tentative contributing instructions in preview notice on documentation homepage with link to contribution guide.
0.1.0 - 2017-10-19¶
Added¶
- Python ports for almost all method and argument annotations in Retrofit.
- Adherence to the variation of the semantic versioning scheme outlined in the official Python package distribution tutorial.
- MIT License
- Documentation with introduction, instructions for installing, and quick getting started guide covering the builder and all method and argument annotations.
- README that contains GitHub API v3 example, installation instructions with
pip
, and link to online documentation.