Permalink
Browse files

Add README.

  • Loading branch information...
1 parent 204176a commit 8eb75ac40c1ef5cb81572a607b70e55840fdcbf7 @hdemers hdemers committed Dec 11, 2012
Showing with 77 additions and 0 deletions.
  1. +33 −0 CONTRIBUTING.md
  2. +44 −0 README.md
View
@@ -0,0 +1,33 @@
+Guidelines for contributing
+===========================
+
+Here are some guidelines for contributing new features, fixing bugs and overall
+adding new code to this project.
+
+
+Pull request checklist
+----------------------
+For the impatient:
+
+ 1. Make sure it's PEP8 compliant.
+ 3. Rebase onto master.
+ 4. Open a pull request on GitHub.
+
+
+Coding style guides
+-------------------
+
+### Python
+You should closely follow the PEP8 style guide described
+[here](http://www.python.org/dev/peps/pep-0008/). However, the best way to
+ensure your code is compliant is to use a tool that automatically checks your
+code, like *pep8.py*. See [this](http://stackoverflow.com/q/399956) for hints
+on how to do that.
+
+
+Versioning
+----------
+
+We use the [semantic versioning](http://semver.org) scheme. The master branch
+should be tagged appropriately.
+
View
@@ -0,0 +1,44 @@
+Cloudly
+=======
+
+We use a lot of cloud stuff here at OODA Technologies. This library
+contains all sort of small helper modules from quickly launching an EC2 instance
+and configuring it according to our taste to wrappers around pub/sub providers,
+to easy connection to a CouchDB.
+
+Currently, this includes wrappers and tools for:
+
+ - AWS
+ - Redis
+ - Redis queues using [RQ](http://python-rq.org/)
+ - CouchDB
+ - memoization
+ - metrics using [Cube](http://square.github.com/cube/)
+ - logging
+ - notification using SNS
+ - publish/subscribe using [PubNub](http://www.pubnub.com/) or
+ [Pusher](http://pusher.com/)
+
+Installation instructions are below. Contribution instructions are in
+[CONTRIBUTING.md](CONTRIBUTING.md).
+
+
+Installation
+------------
+
+You'll need:
+
+ - a redis server
+ - AWS EC2 API tools
+
+On Ubuntu do:
+
+ sudo apt-get install redis-server ec2-api-tools
+
+Then clone this repository:
+
+ git clone git@github.com:ooda/cloudly.git
+
+And install all requirements:
+
+ pip install -r requirements.txt

0 comments on commit 8eb75ac

Please sign in to comment.