From 3193d64e70c91d3cad64b0cec1b180a7a1c67ed0 Mon Sep 17 00:00:00 2001 From: John Anderson Date: Tue, 10 Feb 2015 11:26:56 -0800 Subject: [PATCH] Move to .rst and use it in setup.py for long description --- README.md => README.rst | 23 +++++++++++++++++------ setup.py | 15 +++++++-------- 2 files changed, 24 insertions(+), 14 deletions(-) rename README.md => README.rst (51%) diff --git a/README.md b/README.rst similarity index 51% rename from README.md rename to README.rst index 2bf1965..58814f0 100644 --- a/README.md +++ b/README.rst @@ -1,10 +1,18 @@ -# Kafka Python client +Kafka Python client +------------------------ +.. image:: https://api.travis-ci.org/mumrah/kafka-python.png?branch=master + :target: https://travis-ci.org/mumrah/kafka-pytho + :alt: Build Status -[![Build Status](https://api.travis-ci.org/mumrah/kafka-python.png?branch=master)](https://travis-ci.org/mumrah/kafka-python) -[![Coverage Status](https://coveralls.io/repos/mumrah/kafka-python/badge.svg?branch=master)](https://coveralls.io/r/mumrah/kafka-python?branch=master) -[![Full documentation available on ReadTheDocs](https://readthedocs.org/projects/kafka-python/badge/?version=latest)](https://readthedocs.org/projects/kafka-python/?badge=latest) +.. image:: https://api.travis-ci.org/mumrah/kafka-python.png?branch=master + :target: https://coveralls.io/repos/mumrah/kafka-python/badge.svg?branch=master + :alt: Coverage Status -[Full documentation available on ReadTheDocs](http://kafka-python.readthedocs.org/en/latest/) +.. image:: https://readthedocs.org/projects/kafka-python/badge/?version=latest + :target: http://kafka-python.readthedocs.org/en/latest/ + :alt: Full documentation available on ReadTheDocs + +`Full documentation available on ReadTheDoc`_ This module provides low-level protocol support for Apache Kafka as well as high-level consumer and producer classes. Request batching is supported by the @@ -24,7 +32,7 @@ Copyright 2015, David Arthur under Apache License, v2.0. See `LICENSE` # Status -The current stable version of this package is [**0.9.3**](https://github.com/mumrah/kafka-python/releases/tag/v0.9.3) and is compatible with +The current stable version of this package is **`0.9.3`_** and is compatible with: Kafka broker versions - 0.8.2.0 [offset management currently ZK only -- does not support ConsumerCoordinator offset management APIs] @@ -38,3 +46,6 @@ Python versions - 3.3 (tested on 3.3.5) - 3.4 (tested on 3.4.2) - pypy (tested on pypy 2.4.0 / python 2.7.8) + +.. _Full documentation available on ReadTheDocs: http://kafka-python.readthedocs.org/en/latest/ +.. _0.9.3: https://github.com/mumrah/kafka-python/releases/tag/v0.9.3 diff --git a/setup.py b/setup.py index 4b1e18e..5bdff65 100644 --- a/setup.py +++ b/setup.py @@ -1,5 +1,5 @@ import sys - +import os from setuptools import setup, Command with open('VERSION', 'r') as v: @@ -26,6 +26,10 @@ test_require = ['tox', 'mock'] if sys.version_info < (2, 7): test_require.append('unittest2') +here = os.path.abspath(os.path.dirname(__file__)) + +with open(os.path.join(here, 'README.rst')) as f: + README = f.read() setup( name="kafka-python", @@ -46,15 +50,10 @@ setup( url="https://github.com/mumrah/kafka-python", license="Apache License 2.0", description="Pure Python client for Apache Kafka", - long_description=""" -This module provides low-level protocol support for Apache Kafka as well as -high-level consumer and producer classes. Request batching is supported by the -protocol as well as broker-aware request routing. Gzip and Snappy compression -is also supported for message sets. -""", + long_description=README, keywords="apache kafka", install_requires=['six'], - classifiers = [ + classifiers=[ "Development Status :: 4 - Beta", "Intended Audience :: Developers", "License :: OSI Approved :: Apache Software License",