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.3.0 - 2018-1-09

Added

  • HTTP HEAD request decorator by @brandonio21
  • Support for returning deserialized response objects using marshmallow schemas.
  • Constructor parameter for uplink.Query and uplink.QueryMap to support already encoded URL parameters
  • Support for using requests.Session and aiohttp.ClientSession instances with the client parameter of the uplink.Consumer constructor.

Changed

  • aiohttp and twisted are now optional dependencies/extras.

Fixed

  • Fix issue with calling a request method with super.
  • Fix issue where method decorators would incorrectly decorate inherited request methods.

0.2.2 - 2017-11-23

Fixed

  • Fix error raised when an object that is not a class is passed into the client parameter of the Consumer constructor, by @kadrach.

0.2.0 - 2017-11-03

Added

  • The class uplink.Consumer. 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 inherit uplink.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.