Merge pull request #191 from kirang89/master

Better bootstrapping

Author: radzhome

.gitignore

@@ -34,3 +34,6 @@ pip-log.txt
 
 #Mr Developer
 .mr.developer.cfg
+
+#Environment
+env

Makefile

@@ -0,0 +1,32 @@
+.PHONY: docs test
+
+help:
+	@echo "  env         create a development environment using virtualenv"
+	@echo "  deps        install dependencies"
+	@echo "  clean       remove unwanted stuff"
+	@echo "  lint        check style with flake8"
+	@echo "  test        run tests"
+
+env:
+	sudo easy_install pip && \
+	pip install virtualenv && \
+	virtualenv env && \
+	. env/bin/activate && \
+	make deps
+
+deps:
+	pip install -r requirements.txt --use-mirrors
+
+clean:
+	rm -fr build \
+	rm -fr dist \
+	find . -name '*.pyc' -exec rm -f {} \
+	find . -name '*.pyo' -exec rm -f {} \
+	find . -name '*~' -exec rm -f {}
+
+lint:
+	flake8 twitter > violations.flake8.txt
+
+test:
+	python twitter_test.py
+

README.rst

@@ -38,11 +38,23 @@ Check out the latest development version anonymously with::
 
     $ git clone git://github.com/bear/python-twitter.git
     $ cd python-twitter
+    
+Setup a virtual environment and install dependencies:
 
-Dependencies
+	$ make env
+
+Activate the virtual environment created:
+
+	$ source env/bin/activate
+	
+Run tests:
+
+	$ make test
+	
+To see other options available, run:
+
+	$ make help
 
-* [Requests](http://docs.python-requests.org/en/latest/)
-* [Requests OAuthlib](https://requests-oauthlib.readthedocs.org/en/latest/)
 
 =============
 Documentation

requirements.txt

@@ -0,0 +1,2 @@
+requests
+requests_oauthlib