summaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst41
1 files changed, 41 insertions, 0 deletions
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/