Merge pull request #1 from ClearcodeHQ/feature/initial-ianitor

initial ianitor version

AUTHORS.md

@@ -0,0 +1,8 @@
+# Authors
+This file contains the list of people involved in the development 
+of ianitor along its history.
+
+* Michał Jaworski
+
+Great thanks to [Clearcode](http://clearcode.cc) for allowing releasing
+ianitor as free software!

COPYING

@@ -1,13 +1,165 @@
-        DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
-                    Version 2, December 2004
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
 
- Copyright (C) 2004 Sam Hocevar <[email protected]>
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
 
- Everyone is permitted to copy and distribute verbatim or modified
- copies of this license document, and changing it is allowed as long
- as the name is changed.
 
-            DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
-   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
 
-  0. You just DO WHAT THE FUCK YOU WANT TO.
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

README.md

@@ -1,4 +1,3 @@
-[![WTFPL](http://www.wtfpl.net/wp-content/uploads/2012/12/wtfpl-badge-4.png)](http://www.wtfpl.net/) 
 [![Build Status](https://travis-ci.org/ClearcodeHQ/ianitor.svg?branch=master)](https://travis-ci.org/ClearcodeHQ/ianitor)
 
 # ianitor
@@ -18,13 +17,100 @@ your existing process/service supervision tool like
 
 Simply install with pip:
 
-    pip install ianitor
+    $ pip install ianitor
 
 And you're ready to go with:
 
-    ianitor - yourapp --some-switch
+    $ ianitor appname -- ./yourapp --some-switch
 
+You can check if service is registered diggin' into consul DNS service:
+
+    $ dig @localhost -p 8600 appname.service.consul
+    ; <<>> DiG 9.9.3-P1 <<>> @localhost -p 8600 appname.service.consul
+    ; (1 server found)
+    ;; global options: +cmd
+    ;; Got answer:
+    ;; ->>HEADER<<- opcode: QUERY, status: NOERROR, id: 25966
+    ;; flags: qr aa rd; QUERY: 1, ANSWER: 1, AUTHORITY: 0, ADDITIONAL: 0
+    ;; WARNING: recursion requested but not available
+
+    ;; QUESTION SECTION:
+    ;appname.service.consul.		IN	A
+
+    ;; ANSWER SECTION:
+    appname.service.consul.	0	IN	A	10.54.54.214
+
+    ;; Query time: 44 msec
+    ;; SERVER: 127.0.0.1#8600(127.0.0.1)
+    ;; WHEN: Tue Oct 28 13:53:09 CET 2014
+    ;; MSG SIZE  rcvd: 78
+
+Full usage:
+
+    usage: ianitor [-h] [--consul-agent hostname[:port]] [--ttl seconds]
+                   [--heartbeat seconds] [--tags tag] [--id ID] [--port PORT] [-v]
+                   service-name -- command [arguments]
+
+    Doorkeeper for consul discovered services.
+
+    positional arguments:
+      service-name                    service name in consul cluster
+
+    optional arguments:
+      -h, --help                      show this help message and exit
+      --consul-agent=hostname[:port]  set consul agent address
+      --ttl=seconds                   set TTL of service in consul cluster
+      --heartbeat=seconds             set rocess poll heartbeat (defaults to
+                                      ttl/10)
+      --tags=tag                      set service tags in consul cluster (can be
+                                      used multiple times)
+      --id=ID                         set service id - must be node unique
+                                      (defaults to service name)
+      --port=PORT                     set service port
+      -v, --verbose                   enable logging to stdout (use multiple times
+                                      to increase verbosity)
+
+
+## How does ianitor work?
+
+ianitor spawns process using python's `subprocess.Popen()` with command line
+specified after `--` . It redirects its own stdin to child's stdin and
+childs stdout/stderr to his own stdout/stderr.
+
+This way ianitor does not interfere with logging of managed service if it
+logs to stdout. Moreover ianitor does not log anything to make it easier to
+plug it in your existing process supervision tool.
+
+ianitor handles service registration in consul agent as well as keeping
+registered service entry in consul in "healthy" state by continously requesting
+it's [TTL health check endpoint](http://www.consul.io/docs/agent/checks.html). 
+
+## Example supervisord config
+
+Assuming that you have some service under supervisord supervision:
+
+    [program:rabbitmq]
+    command=/usr/sbin/rabbitmq-server
+    priority=0
+
+    autostart=true
+
+Simply wrap it with ianitor call:
+
+    [program:rabbitmq]
+    command=/usr/local/bin/ianitor rabbitmq -- /usr/sbin/rabbitmq-server
+    priority=0
+
+    autostart=true
+
 ## Licence
 
-This code is under [WTFPL](https://en.wikipedia.org/wiki/WTFPL).
-Just do what the fuck you want with it.
+`ianitor`  is licensed under LGPL license, version 3.
+
+
+## Contributing and reporting bugs
+
+Source code is available at: 
+[ClearcodeHQ/ianitor](https://github.com/ClearcodeHQ/ianitor). Issue tracker 
+is located at [GitHub Issues](https://github.com/ClearcodeHQ/ianitor/issues).
+Projects [PyPi page](https://pypi.python.org/pypi/ianitor).

requirements-tests.txt

@@ -0,0 +1,2 @@
+pytest
+mock

requirements.txt

@@ -1 +1 @@
-requests
+python-consul

setup.py

@@ -1,5 +1,22 @@
 # -*- coding: utf-8 -*-
-# -*- coding: utf-8 -*-
+# Copyright (C) 2014 by Clearcode <http://clearcode.cc>
+# and associates (see AUTHORS.md).
+
+# This file is part of ianitor.
+
+# mirakuru is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# ianitor is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+
+# You should have received a copy of the GNU Lesser General Public License
+# along with ianitor.  If not, see <http://www.gnu.org/licenses/>.
+
 from setuptools import setup, find_packages
 import os
 
@@ -25,33 +42,43 @@ def get_version(version_tuple):
 
 INSTALL_REQUIRES = reqs('requirements.txt')
 
-README = open(os.path.join(os.path.dirname(__file__), 'README.md')).read()
+try:
+    from pypandoc import convert
+    read_md = lambda f: convert(f, 'rst')
+except ImportError:
+    print(
+        "warning: pypandoc module not found, could not convert Markdown to RST"
+    )
+    read_md = lambda f: open(f, 'r').read()
+
+README = os.path.join(os.path.dirname(__file__), 'README.md')
 PACKAGES = find_packages('src')
 PACKAGE_DIR = {'': 'src'}
 
 setup(
     name='ianitor',
     version=VERSION,
-    author='Michał Jaworski',
-    author_email='[email protected]',
+    author='Clearcode - The A Room',
+    author_email='[email protected]',
     description='Doorkeeper for consul discovered services.',
-    long_description=README,
+    long_description=read_md(README),
 
     packages=PACKAGES,
     package_dir=PACKAGE_DIR,
 
-    url='https://github.com/swistakm/ianitor',
+    url='https://github.com/ClearcodeHQ/ianitor',
     include_package_data=True,
     install_requires=INSTALL_REQUIRES,
     zip_safe=False,
 
-    license="WTFPL",
+    license="LGPL",
     classifiers=[
         'Development Status :: 4 - Beta',
         'Intended Audience :: Developers',
         'Operating System :: OS Independent',
         'Programming Language :: Python',
         'Programming Language :: Python :: 3',
+        'License :: OSI Approved :: GNU Lesser General Public License v3 or later (LGPLv3+)',  # noqa
     ],
 
     entry_points={