Permalink
Browse files

updated README + pip requirements

  • Loading branch information...
1 parent 628d9c4 commit 7ae861e2d3aeb17364522f9f45427838d9487222 @dexterbt1 committed May 26, 2012
Showing with 30 additions and 12 deletions.
  1. +18 −12 README.markdown
  2. +12 −0 pip.requirements.txt
View
@@ -1,6 +1,7 @@
# cuisine\_sweet
-Sugar-coated declarative recipes built on top of [Fabric](http://fabfile.org) and [Cuisine](https://github.com/sebastien/cuisine)
+Sugar-coated declarative deployment recipes built on top of [Fabric](http://fabfile.org) and [Cuisine](https://github.com/sebastien/cuisine)
+
# Sample fabfile.py
@@ -27,32 +28,37 @@ Sugar-coated declarative recipes built on top of [Fabric](http://fabfile.org) an
ensure.supervisord.running('git/myproject/supervisord.conf', '/tmp/myproject.supervisord.pid')
ensure.supervisord.updated_with_latest_config('git/myproject/supervisord.conf')
+
# Installation
This module is available on PyPI and via Github directly.
-* Using pip: `pip install cuisine_sweet`.
-* Using setuptools. `easy_install cuisine_sweet`.
-* Or clone + `python setup install`
+* Using pip: `pip install cuisine_sweet`
+* Using setuptools: `easy_install cuisine_sweet`
+* Or clone this repository and do a `python setup install`
# Ensure Modules
-* git
-* local\_git
-* yum
-* supervisord
-* user\_crontab
-* fs
-* cpan\_module
-* git
+At the heart of `cuisine_sweet` is the collection of ensure modules. These modules encapsulate
+what is being checked/deployed (declarative), without specifying the how and the where parts
+(imperative). An ensure API is an assertion in the form: ensure.object.state(params)
+
+* git - rsync-style git deployment
+* local\_git - assertions on the current git repo of the fabfile
+* yum - yum package management
+* supervisord - service management via supervisord
+* user\_crontab - user's crontab file/state assertions
+* fs - filesystem related checks/assertions
+* cpan\_module - locallib-flavored perl CPAN module deployments
# Warning
This is experimental alpha-quality stuff. The API and implementation are still highly fluid and continuously evolving.
See LICENSE file for more information.
+
# References
* Fabric - http://fabfile.org
View
@@ -0,0 +1,12 @@
+Fabric==1.4.2
+Jinja2==2.6
+PyYAML==3.10
+Pygments==1.5
+Sphinx==1.1.3
+cuisine==0.2.6
+distribute==0.6.19
+docutils==0.9
+pexpect==2.4
+pycrypto==2.6
+ssh==1.7.14
+wsgiref==0.1.2

0 comments on commit 7ae861e

Please sign in to comment.