Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Initial commit

  • Loading branch information...
commit e4055117f16752567dcfa64e138fa4cf2605f68b 0 parents
Michael Huynh authored
Showing with 73 additions and 0 deletions.
  1. +5 −0 .gitignore
  2. +50 −0 README.md
  3. +1 −0  requirements.txt
  4. +17 −0 setup.py
5 .gitignore
@@ -0,0 +1,5 @@
+.DS_Store
+*.swp
+*.pyc
+env/
+pip-log.txt
50 README.md
@@ -0,0 +1,50 @@
+python-firebase
+===============
+http://github.com/mikexstudios/python-firebase
+by Michael Huynh (mike@mikexstudios.com)
+
+Purpose:
+-------
+
+A very simple wrapper for Firebase's REST API.
+
+How to use
+----------
+
+1. Install python-firebase using pip:
+
+ pip install -e git://github.com/mikexstudios/python-firebase.git#egg=python-firebase
+
+ or with easy_install (not recommended):
+
+ easy_install http://github.com/mikexstudios/python-firebase/tarball/master
+
+ Note that python-firebase depends on requests (http://python-requests.org),
+ a REST/http client for python. If you used pip or easy_install, the
+ dependency should automatically be installed.
+
+2. Then simply import firebase at the top of your python script:
+
+ from firebase import Firebase
+
+ and then instantiate Firebase, passing in your root url:
+
+ f = Firebase('http://demo.firebase.com/SampleChat')
+
+ Now call the different methods of the Firebase class (see the Firebase
+ REST API page: http://www.firebase.com/docs/rest-api.html and the source of
+ `firebase/__init__.py` for what methods are available and how to call
+ them). For example, to push a list of data:
+
+ r = f.push('message_list', {'user_id': 'wilma', 'text': 'Hello'})
+
+ The response `r` is a dictionary containing Firebase's REST response:
+
+ {"name":"-INOQPH-aV_psbk3ZXEX"}
+
+
+License
+-------
+
+django-firebase is BSD licensed.
+
1  requirements.txt
@@ -0,0 +1 @@
+requests
17 setup.py
@@ -0,0 +1,17 @@
+from setuptools import setup, find_packages
+
+setup(
+ name = 'python-firebase',
+ packages = find_packages(),
+ version = '0.1.0',
+ description = "Simple wrapper around Firebase's REST API",
+ author = 'Michael Huynh',
+ author_email = 'mike@mikexstudios.com',
+ url = 'http://github.com/mikexstudios/python-firebase',
+ install_requires = ['requests'],
+ classifiers = [
+ 'Programming Language :: Python',
+ 'License :: OSI Approved :: BSD License',
+ ]
+)
+
Please sign in to comment.
Something went wrong with that request. Please try again.