Change-Id: Ic30ef00d39126d5a6f00a29893ed760bf4e753c6
Closes-Bug: #1825936

Use latest release 1.1.0 and compatible changes w.r.t pep8

Change-Id: I95d62bbce7fe20dd2f9ec8a96cdffeeefcda75be

The README points to the documentation instead of to Launchpad
where bugs are reported.
The patch fixes that.

Change-Id: Ia13633dc02e74c39565429c93d5a217bba5acbb2

Change-Id: I1c3cd17d02974073ed42b383a1963be77c380bd2

Pypi url changed from [1] to [2]

[1] https://pypi.python.org/pypi/<package>
[2] https://pypi.org/project/<package>

Change-Id: Ib3d10ec830d3e79194629d63d9bb4570daad0689

Change the outdated links to the latest links in README

Change-Id: I41925678683a8fe00e2e4e9ae7bb3bee7223f288

Change-Id: I3230bd42051dc74f2185e50a7d1f5cb90d61f7c8

This patch adds the team's and repository's badges to the README file.
The motivation behind this is to communicate the project status and
features at first glance.

For more information about this effort, please read this email thread:

http://lists.openstack.org/pipermail/openstack-dev/2016-October/105562.html

To see an example of how this would look like check:

b'https://gist.github.com/4d5b24484f965cc0a7ad252d9ffff20a\n'

Change-Id: I5453d4039c48a263a9fd373ea93cda82a46d0ee7

Writing a code using the base64 module (of the Python standard
library) working on Python 2.7 and 3.4 requires many checks on the
input and/or output type:

* base64.b64encode() only accepts byte string: text must be
  explicitly encoded to ASCII
* base64.b64decode() returns bytes: output must be decoded from UTF-8
  when text is expected

This change adds two pairs of encode/decode functions:

* encode_as_bytes(), decode_as_bytes(): always return the result as
  a byte string
* encode_as_text(), decode_as_text(): always return the result as a
  text string

Encode functions accept text: text is encoded to UTF-8 by default,
but the encoding is configurable.

Decode functions accept text: text is decoded from ASCII.

decode_as_text() decodes the result from UTF-8 by default, but again
the encoding is configurable.


The new submodule is called "base64" to be able to replace:

    import base64

with:

    from oslo_serialization import base64

If the base64 module of the stdlib is needed, it can be imported as a
different name. Example:

    import base64 as std_base64


The encoding example:

    if isinstance(text, six.text_type):
       text = text.encode('utf-8')
    text_b64 = base64.b64encode(text)
    text_b64 = text_b64.decode('ascii')

can be replaced with:

    text_b64 = base64.encode_as_text(text)


The decoding example:

    if isinstance(encoded, six.text_type):
       encoded = encoded.decode('ascii')
    text = base64.b64decode(encoded)
    text = text.decode('utf-8')

can be replaced with:

    text = base64.decode_as_text(text)

Change-Id: Icf8df9c947bc0c5f4838508b756ed8f53efd9fc4

The badge hosting at 'pypip.in' has been broken for a while
now, it was supposed to be fixed in the following PR(s):

- https://github.com/badges/pypipins/issues/39
- https://github.com/badges/pypipins/issues/38
- https://github.com/badges/pypipins/issues/37

That does not appear to have actually happened and/or is not
getting addressed, so switch to a more reliable badge hosting
site that provides the same badge information.

Change-Id: Iedef01ac48d266c187cb8cd7d4dd7fee09a63162

Also makes the docs look more like the other
oslo libraries so that the content is easily readable
across projects.

Change-Id: I2a3497bcbf72bc4a0e6fb12f7c2d508bb3a4e6bc

Provide a more complete description in README.rst, which is used
when viewing the library on pypi.

Also standardize the short-description used in setup.cfg.

Change-Id: Ic917b8c1d0038e734f7a7b0864a71e0e778fd9b9

Change-Id: Iedbebac71239aa3d4b54a553467b9ba5f9c2db63

Add basic API documentation and release notes.

Change-Id: I18fc06d23d8e46baf153a150e6af896c7bb67f04