Metadata-Version: 1.1
Name: sous-chef
Version: 0.10.4
Summary: A small webapp for viewing and searching Chef nodes
Home-page: https://github.com/datasift/sous-chef
Author: Sam Clements
Author-email: sam.clements@datasift.com
License: UNKNOWN
Description: Sous-chef
        =========
        
        .. image:: https://pypip.in/v/sous-chef/badge.png
            :target: https://pypi.python.org/pypi/sous-chef
            :alt: Latest PyPI version
        
        A small webapp for viewing Chef nodes and other metadata. Currently supports
        nodes, roles, and environments, as well as package version information (see
        below).
        
        Usage
        -----
        
        Run Sous-chef using `Gunicorn`_::
        
        	gunicorn 'sous_chef:create_app()'
        
        Configuration
        ^^^^^^^^^^^^^
        
        Sous-chef will read it's configuration from one of two places, depending on how
        it was installed::
        
        	# Global install
        	/usr/var/sous_chef-instance/config.py
        
        	# Virtualenv install
        	$VIRTUALENV/var/sous_chef-instance/config.py
        
        An example configuration file might look like this::
        
        	# The URL of the Chef server
        	CHEF_URL = 'http://chef.example.com'
        
        	# The client name and key to use
        	CHEF_CLIENT = 'sous'
        	CHEF_KEY = '/usr/var/sous_chef-instance/sous.pem'
        
        If these are not set, PyChef's ``autoconfigure`` function is used as a fallback,
        and will try and load it's configuration from ``~/.chef/knife.rb`` or
        ``/etc/chef/client.rb``.
        
        Package versions
        ^^^^^^^^^^^^^^^^
        
        Sous-chef will display package metadata from nodes if availible. It expects this
        data to be in the following format::
        
        	"packages": {
        		"<package_type>": {
        			"<package_name>": "<package_version",
        			...
        		},
        		...
        	}
        
        For example, an RPM Ohai plugin could set the following node attributes::
        
        	"packages": {
        		"rpm": {
        			"package-one": "0.1.0",
        			"pacakge-two": "2.0.1"
        		}
        	}
        
        Debug mode
        ^^^^^^^^^^
        
        The app can be run in debug mode by using the ``create_debug_app`` function::
        
        	gunicorn 'sous_chef:create_debug_app()'
        
        The ``flask-debugtoolbar`` package is availible, the DebugToolbar extension will
        be used.
        
        .. _Flask instance folder: http://flask.pocoo.org/docs/config/#instance-folders
        
        Installation
        ------------
        
        Install Sous-chef and Gunicorn with::
        
        	pip install 'sous-chef[deploy]'
        
        Requirements
        ^^^^^^^^^^^^
        
        Requires `Flask`_ and `PyChef`_. `Gunicorn`_ is the simplest method of
        deployment, but is not a requirement (allowing alternate WSGI servers to be
        used). Optionally uses `Flask Debug Toolbar`_ using the debug application.
        
        .. _Flask: http://flask.pocoo.org/
        .. _PyChef: https://github.com/coderanger/pychef
        .. _Gunicorn: http://gunicorn.org/
        .. _Flask Debug Toolbar: https://pypi.python.org/pypi/Flask-DebugToolbar
        
        Compatibility
        ^^^^^^^^^^^^^
        
        Targets Python 2.6 and 2.7.
        
        PyChef is currently Python 2 only, but if or when it is availible for Python 3
        Sous-chef should have no problems.
        
        Licence
        -------
        
        The MIT License (MIT)
        
        Copyright (c) 2014 DataSift <opensource@datasift.com>
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in
        all copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
        THE SOFTWARE.
        
        Authors
        -------
        
        ``sous-chef`` was written by `Sam Clements <sam.clements@datasift.com>`_ at
        `DataSift <https://datasift.com>`_.
        
        .. image:: https://gravatar.com/avatar/8dd5661684a7385fe723b7e7588e91ee?s=40
        .. image:: https://gravatar.com/avatar/a3a6d949b43b6b880ffb3e277a65f49d?s=40
        
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
