Krakenex

--------------------------------

**Yanked** due to clean-room ``pip`` installation failing.

----------------------------------

**Internal alpha testing release!** Not for general use. For that
reason, ``pip`` package not provided.

Added
^^^^^
* ``krakenex.API.session`` attribute, which is a ``requests.Session``.
* ``krakenex.API.response`` attribute, which is a ``requests.Response``
object for the previous query. It is available whether the query
was successful or has failed.

Changed
^^^^^^^
* It is now recommended to install with ``pip`` in a ``virtualenv``.
See ``README`` for details.

Removed
^^^^^^^
* ``krakenex.Connection`` class. Obsoleted by use of ``requests.Session``.
* ``krakenex.API.conn`` attribute, which was a ``krakenex.Connection``
object.
* ``krakenex.API.set_connection()`` method (deprecated since ``v1.0.0``).

------------------------------

For a detailed list of changes, refer to the same-number releases below.

Migration instructions
^^^^^^^^^^^^^^^^^^^^^^
* If you were previously calling ``API.query_private()`` or
``API.query_public()`` in a ``try/except`` block, be aware that
these two may now throw a ``http.client.HTTPException``, if the
underlying ``Connection`` returns a non-`20x` status code. (`17`_)

Deprecated
^^^^^^^^^^
* ``krakenex.API.set_connection()`` method. Access ``krakenex.API.conn``
attribute directly.

Known issues
^^^^^^^^^^^^
* There is no straightforward way to reset the ``krakenex.API`` object's
connection ``krakenex.API.conn``. (`53`_)

The recommended workaround for now, assuming ``k = krakenex.API()``:

.. code-block:: python

k.conn.close()
k.conn = None

If a connection is not closed prior to the reference being removed, the
connection may continue to linger, preventing removal of the object by
the garbage collector.

.. _17: https://github.com/veox/python3-krakenex/pull/17
.. _53: https://github.com/veox/python3-krakenex/issues/53

--------------------------------

**Release candidate.** Not recommended for production use.

Added
^^^^^
* Minimal Travis CI integration_. (`45`_)

.. _integration: https://travis-ci.org/veox/python3-krakenex
.. _45: https://github.com/veox/python3-krakenex/issues/45

--------------------------------

**Internal alpha testing release!** Not for general use. For that
reason, ``pip`` package not provided.

Changed
^^^^^^^
* Cleaned up examples.

--------------------------------

**Internal alpha testing release!** Not for general use. For that
reason, ``pip`` package not provided.

Added
^^^^^
* More examples.

Changed (breaking!)
^^^^^^^^^^^^^^^^^^^
* Low-level ``Connection._request`` now raises
``http.client.HTTPException`` if response doesn't have ``20x``
status code. This propagates all the way up, to
``API.query_{private,public}``. (`17`_)

Changed
^^^^^^^
* Fix new connection thrashing if one is not provided for reuse
(as was described in the docs). (`27`_)
* Be explicit when using default arguments in functions that have
optional ones. (`19`_)
* Renamed ``NEWS`` to ``CHANGELOG``.

Deprecated
^^^^^^^^^^
* ``krakenex.API.set_connection()`` method. Access ``krakenex.API.conn``
attribute directly.

.. _17: https://github.com/veox/python3-krakenex/pull/17
.. _19: https://github.com/veox/python3-krakenex/issues/19
.. _27: https://github.com/veox/python3-krakenex/issues/27