Feature/sphinx docs (severb#100)

* sphinx docs build support

* simplifying and reworking docs

* fixing variable name shadow issue

Author: nklapste

.gitignore

@@ -67,6 +67,9 @@ instance/
 # Sphinx documentation
 docs/_build/
 
+# Sphinx API documentation
+docs/api/
+
 # PyBuilder
 target/
 

.travis.yml

@@ -4,8 +4,7 @@ stages:
   - lint
   - test
   - build
-# TODO: needs additional setup
-#  - deploy
+  - deploy
 
 before_install:
   - pip install codecov
@@ -14,19 +13,13 @@ install:
   - pip install .
 
 before_script:
-  - cd tests/config
-  - bash create_ssl_certs.sh -h localhost -i 127.0.0.1
-  - cd ../..
-  - docker-compose -f tests/config/docker-compose.yml down
-  - docker-compose -f tests/config/docker-compose.yml up -d
-  - sleep 40
-  - "curl -u admin:admin 'http://127.0.0.1:9000/api/search/universal/relative?query=test&range=5&fields=message' || true"
+  - bash tests/config/start_local_graylog_server.sh
 
 script:
   - python setup.py test
 
 after_script:
-  - docker-compose -f tests/config/docker-compose.yml down
+  - bash tests/config/stop_local_graylog_server.sh
 
 after_success:
   - codecov
@@ -76,6 +69,15 @@ jobs:
       script:
         - python setup.py bdist_wheel
       after_script: skip
+    - name: "sphinx docs"
+      python:
+        - 3.6
+      install:
+        - pip install .[docs,amqp]
+      before_script: skip
+      script:
+        - sphinx-build docs/ build/
+      after_script: skip
     - stage: deploy
       deploy:
         python:

MANIFEST.in

@@ -1,3 +1,4 @@
 include LICENSE
 include README.rst
-recursive-include tests *.py
+recursive-include tests *.py
+recursive-include tests/config *

README.rst

@@ -1,72 +1,83 @@
-|PyPI_Status|
-|Build_Status|
-|Coverage_Status|
+######
+graypy
+######
+
+.. image:: https://img.shields.io/pypi/v/graypy.svg
+    :target: https://pypi.python.org/pypi/graypy
+    :alt: PyPI Status
+
+.. image:: https://travis-ci.org/severb/graypy.svg?branch=master
+    :target: https://travis-ci.org/severb/graypy
+    :alt: Build Status
+
+.. image:: https://readthedocs.org/projects/graypy/badge/?version=stable
+    :target: https://graypy.readthedocs.io/en/stable/?badge=stable
+    :alt: Documentation Status
+
+.. image:: https://codecov.io/gh/severb/graypy/branch/master/graph/badge.svg
+    :target: https://codecov.io/gh/severb/graypy
+    :alt: Coverage Status
 
 Description
 ===========
 
-Python logging handlers that send messages in the Graylog Extended
-Log Format (GELF_).
+Python logging handlers that send log messages in the
+Graylog Extended Log Format (GELF_).
+
+graypy supports sending GELF logs to both Graylog2 and Graylog3 servers.
 
 Installing
 ==========
 
 Using pip
 ---------
 
-Install the basic graypy python logging handlers
+Install the basic graypy python logging handlers:
 
-.. code-block:: bash
+.. code-block:: console
 
     pip install graypy
 
-Install with requirements for ``GELFRabbitHandler``
+Install with requirements for ``GELFRabbitHandler``:
 
-.. code-block:: bash
+.. code-block:: console
 
     pip install graypy[amqp]
 
 Using easy_install
 ------------------
 
-Install the basic graypy python logging handlers
+Install the basic graypy python logging handlers:
 
-.. code-block:: bash
+.. code-block:: console
 
-   easy_install graypy
+    easy_install graypy
 
-Install with requirements for ``GELFRabbitHandler``
+Install with requirements for ``GELFRabbitHandler``:
 
-.. code-block:: bash
+.. code-block:: console
 
-  easy_install graypy[amqp]
+    easy_install graypy[amqp]
 
 Usage
 =====
 
-Messages are sent to Graylog2 using a custom handler for the builtin logging
-library in GELF format
+graypy sends GELF logs to a Graylog server via subclasses of the python
+`logging.Handler`_ class.
 
-.. code-block:: python
+Below is the list of ready to run GELF logging handlers defined by graypy:
 
-    import logging
-    import graypy
-
-    my_logger = logging.getLogger('test_logger')
-    my_logger.setLevel(logging.DEBUG)
-
-    handler = graypy.GELFUDPHandler('localhost', 12201)
-    my_logger.addHandler(handler)
+* ``GELFUDPHandler`` - UDP log forwarding
+* ``GELFTCPHandler`` - TCP log forwarding
+* ``GELFTLSHandler`` - TCP log forwarding with TLS support
+* ``GELFHTTPHandler`` - HTTP log forwarding
+* ``GELFRabbitHandler`` - RabbitMQ log forwarding
 
-    my_logger.debug('Hello Graylog2.')
+UDP Logging
+-----------
 
-Alternately, use ``GELFRabbitHandler`` to send messages to RabbitMQ and
-configure your Graylog2 server to consume messages via AMQP. This prevents
-log messages from being lost due to dropped UDP packets (``GELFUDPHandler``
-sends messages to Graylog2 using UDP). You will need to configure RabbitMQ
-with a 'gelf_log' queue and bind it to the 'logging.gelf' exchange so
-messages are properly routed to a queue that can be consumed by
-Graylog2 (the queue and exchange names may be customized to your liking)
+UDP Log forwarding to a locally hosted Graylog server can be easily done with
+the ``GELFUDPHandler``:
 
 .. code-block:: python
 
@@ -76,12 +87,21 @@ Graylog2 (the queue and exchange names may be customized to your liking)
     my_logger = logging.getLogger('test_logger')
     my_logger.setLevel(logging.DEBUG)
 
-    handler = graypy.GELFRabbitHandler('amqp://guest:guest@localhost/', exchange='logging.gelf')
+    handler = graypy.GELFUDPHandler('localhost', 12201)
     my_logger.addHandler(handler)
 
-    my_logger.debug('Hello Graylog2.')
+    my_logger.debug('Hello Graylog.')
 
-Tracebacks are added as full messages
+RabbitMQ Logging
+----------------
+
+Alternately, use ``GELFRabbitHandler`` to send messages to RabbitMQ and
+configure your Graylog server to consume messages via AMQP. This prevents log
+messages from being lost due to dropped UDP packets (``GELFUDPHandler`` sends
+messages to Graylog using UDP). You will need to configure RabbitMQ with a
+``gelf_log`` queue and bind it to the ``logging.gelf`` exchange so messages
+are properly routed to a queue that can be consumed by Graylog (the queue and
+exchange names may be customized to your liking).
 
 .. code-block:: python
 
@@ -91,29 +111,22 @@ Tracebacks are added as full messages
     my_logger = logging.getLogger('test_logger')
     my_logger.setLevel(logging.DEBUG)
 
-    handler = graypy.GELFUDPHandler('localhost', 12201)
+    handler = graypy.GELFRabbitHandler('amqp://guest:guest@localhost/', exchange='logging.gelf')
     my_logger.addHandler(handler)
 
-    try:
-        puff_the_magic_dragon()
-    except NameError:
-        my_logger.debug('No dragons here.', exc_info=1)
+    my_logger.debug('Hello Graylog.')
 
-
-For more detailed usage information please see the documentation provided
-within graypy's handler's docstrings.
-
-Using with Django
-=================
+Django Logging
+--------------
 
 It's easy to integrate ``graypy`` with Django's logging settings. Just add a
 new handler in your ``settings.py``:
 
 .. code-block:: python
 
     LOGGING = {
-        ...
-
+        'version': 1,
+        # other dictConfig keys here...
         'handlers': {
             'graypy': {
                 'level': 'WARNING',
@@ -122,7 +135,6 @@ new handler in your ``settings.py``:
                 'port': 12201,
             },
         },
-
         'loggers': {
             'django.request': {
                 'handlers': ['graypy'],
@@ -132,29 +144,57 @@ new handler in your ``settings.py``:
         },
     }
 
-Custom fields
-=============
+Traceback Logging
+-----------------
+
+By default log captured exception tracebacks are added to the GELF log as
+``full_message`` fields:
+
+.. code-block:: python
+
+    import logging
+    import graypy
+
+    my_logger = logging.getLogger('test_logger')
+    my_logger.setLevel(logging.DEBUG)
+
+    handler = graypy.GELFUDPHandler('localhost', 12201)
+    my_logger.addHandler(handler)
+
+    try:
+        puff_the_magic_dragon()
+    except NameError:
+        my_logger.debug('No dragons here.', exc_info=1)
+
+Default Logging Fields
+----------------------
+
+By default a number of debugging logging fields are automatically added to the
+GELF log if available:
 
-A number of custom fields are automatically added if available:
     * function
     * pid
     * process_name
     * thread_name
 
-You can disable these additional fields if you don't want them by adding
-an the ``debugging_fields=False`` to the handler:
+You can disable automatically adding these debugging logging fields by
+specifying ``debugging_fields=False`` in the handler's constructor:
 
 .. code-block:: python
 
     handler = graypy.GELFUDPHandler('localhost', 12201, debugging_fields=False)
 
-graypy also supports additional fields to be included in the messages sent
-to Graylog2. This can be done by using Python's LoggerAdapter_ and
-Filter_. In general, LoggerAdapter makes it easy to add static information
-to your log messages and Filters give you more flexibility, for example to
-add additional information based on the message that is being logged.
+Adding Custom Logging Fields
+----------------------------
+
+graypy also supports including custom fields in the GELF logs sent to Graylog.
+This can be done by using Python's LoggerAdapter_ and Filter_ classes.
+
+Using LoggerAdapter
+^^^^^^^^^^^^^^^^^^^
 
-Example using LoggerAdapter_
+LoggerAdapter_ makes it easy to add static information to your GELF log
+messages:
 
 .. code-block:: python
 
@@ -170,9 +210,13 @@ Example using LoggerAdapter_
     my_adapter = logging.LoggerAdapter(logging.getLogger('test_logger'),
                                        {'username': 'John'})
 
-    my_adapter.debug('Hello Graylog2 from John.')
+    my_adapter.debug('Hello Graylog from John.')
 
-Example using Filter_
+Using Filter
+^^^^^^^^^^^^
+
+Filter_ gives more flexibility and allows for dynamic information to be
+added to your GELF logs:
 
 .. code-block:: python
 
@@ -183,7 +227,7 @@ Example using Filter_
         def __init__(self):
             # In an actual use case would dynamically get this
             # (e.g. from memcache)
-            self.username = "John"
+            self.username = 'John'
 
         def filter(self, record):
             record.username = self.username
@@ -197,25 +241,17 @@ Example using Filter_
 
     my_logger.addFilter(UsernameFilter())
 
-    my_logger.debug('Hello Graylog2 from John.')
+    my_logger.debug('Hello Graylog from John.')
 
-Contributors:
+Contributors
+============
 
   * Sever Banesiu
   * Daniel Miller
   * Tushar Makkar
   * Nathan Klapstein
 
-.. _GELF: http://docs.graylog.org/en/latest/pages/gelf.html
-.. _LoggerAdapter: http://docs.python.org/howto/logging-cookbook.html#using-loggeradapters-to-impart-contextual-information
-.. _Filter: http://docs.python.org/howto/logging-cookbook.html#using-filters-to-impart-contextual-information
-
-.. |Build_Status| image:: https://travis-ci.org/severb/graypy.svg?branch=master
-    :target: https://travis-ci.org/severb/graypy
-
-
-.. |Coverage_Status| image:: https://codecov.io/gh/severb/graypy/branch/master/graph/badge.svg
-    :target: https://codecov.io/gh/severb/graypy
-
-.. |PyPI_Status| image:: https://img.shields.io/pypi/v/graypy.svg
-    :target: https://pypi.python.org/pypi/graypy
+.. _GELF: https://docs.graylog.org/en/latest/pages/gelf.html
+.. _logging.Handler: https://docs.python.org/3/library/logging.html#logging.Handler
+.. _LoggerAdapter: https://docs.python.org/howto/logging-cookbook.html#using-loggeradapters-to-impart-contextual-information
+.. _Filter: https://docs.python.org/howto/logging-cookbook.html#using-filters-to-impart-contextual-information