From 24e74cfb2924c63f0c6b8b39471a7d7fd65bbfdc Mon Sep 17 00:00:00 2001 From: Vinay Sajip Date: Mon, 20 Feb 2017 18:22:38 +0000 Subject: Updated README format. --- README.rst | 41 +++++++++++++++++++++++++++++++++++++++++ README.txt | 34 ---------------------------------- setup.py | 4 ++-- 3 files changed, 43 insertions(+), 36 deletions(-) create mode 100644 README.rst delete mode 100644 README.txt diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..0070fea --- /dev/null +++ b/README.rst @@ -0,0 +1,41 @@ +.. image:: https://travis-ci.org/vsajip/logutils.svg + :target: https://travis-ci.org/vsajip/logutils + +.. image:: https://coveralls.io/repos/vsajip/logutils/badge.svg + :target: https://coveralls.io/github/vsajip/logutils + +logutils 0.3.4 +============== +The logutils package provides a set of handlers for the Python standard +library's logging package. + +Some of these handlers are out-of-scope for the standard library, and +so they are packaged here. Others are updated versions which have +appeared in recent Python releases, but are usable with older versions +of Python and so are packaged here. + +Requirements & Installation +--------------------------- +The logutils package requires Python 2.5 or greater, and can be +installed with the standard Python installation procedure: + + python setup.py install + +There is a set of unit tests which you can invoke with + + python setup.py test + +before running the installation. + +Availability & Documentation +---------------------------- + +The source code repository is at: + +https://bitbucket.org/vinay.sajip/logutils/ + +Documentation is available at: + +https://logutils.readthedocs.io/ + +https://pythonhosted.org/logutils/ diff --git a/README.txt b/README.txt deleted file mode 100644 index a60fbaf..0000000 --- a/README.txt +++ /dev/null @@ -1,34 +0,0 @@ -logutils 0.3.4 -============== -The logutils package provides a set of handlers for the Python standard -library's logging package. - -Some of these handlers are out-of-scope for the standard library, and -so they are packaged here. Others are updated versions which have -appeared in recent Python releases, but are usable with older versions -of Python and so are packaged here. - -Requirements & Installation ---------------------------- -The logutils package requires Python 2.5 or greater, and can be -installed with the standard Python installation procedure: - - python setup.py install - -There is a set of unit tests which you can invoke with - - python setup.py test - -before running the installation. - -Availability & Documentation ----------------------------- -The latest version of logutils can be found at: - - http://code.google.com/p/logutils/ - -The source code repository is at: - -https://bitbucket.org/vinay.sajip/logutils/ - - diff --git a/setup.py b/setup.py index 7ee0117..f0891d6 100644 --- a/setup.py +++ b/setup.py @@ -7,10 +7,10 @@ import re def description(): - f = open(join(dirname(__file__), 'README.txt')) + f = open(join(dirname(__file__), 'README.rst')) readme = f.read() f.close() - regexp = r'^logutils\s*[\d.]*\s*\n=======+\s*\n(.*)Requirements ' + regexp = r'logutils\s*[\d.]*\s*\n=======+\s*\n(.*)Requirements ' reqts, = re.findall(regexp, readme, re.DOTALL) regexp = r'Availability & Documentation\s*\n-----+\s*\n(.*)' avail, = re.findall(regexp, readme, re.DOTALL) -- cgit v1.2.1