# Python interface to the Google's Firebase REST APIs
###### Author: [Joe Tilsed](http://linkedin.com/in/joetilsed) | Created: 09.02.2019 | Last Updated: 22.02.2023 | Version 4.0.1
# Firebase
Python interface to the Google's Firebase REST APIs
[](http://www.firebase.com)
## Installation
$ pip install firebase
## Getting Started
You can fetch any of your data in JSON format by appending '.json' to the end of the URL in which your data resides and, then send an HTTPS request through your browser. Like all other REST specific APIs, Firebase offers a client to update(PATCH, PUT), create(POST), or remove(DELETE) his stored data along with just to fetch it.
The library provides all the corresponding methods for those actions in both synchronous and asynchronous manner. You can just start an asynchronous GET request with your callback function, and the method
To fetch all the users in your storage simply do the following:
```python
from firebase import firebase
firebase = firebase.FirebaseApplication('https://your_storage.firebaseio.com', None)
result = firebase.get('/users', None)
print(result)
>> {'1': 'Joe Tilsed', '2': 'Sydney Cox'}
```
The second argument of **get** method is the name of the snapshot. Thus, if you leave it NULL, you get the data in the URL **/users.json**. Besides, if you set it to **1**, you get the data in the url **/users/1.json**. In other words, you get the user whose ID equals to 1.
```python
from firebase import firebase
firebase = firebase.FirebaseApplication('https://your_storage.firebaseio.com', None)
result = firebase.get('/users', '1')
print(result)
>> {'1': 'Joe Tilsed'}
```
You can also provide extra query parameters that will be appended to the url or extra key-value pairs sent in the HTTP header.
```python
from firebase import firebase
firebase = firebase.FirebaseApplication('https://your_storage.firebaseio.com', None)
result = firebase.get('/users/2', None, {'print': 'pretty'}, {'X_FANCY_HEADER': 'VERY FANCY'})
print(result)
>> {'2': 'Sydney Cox'}
```
Creating new data requires a POST or PUT request. Assuming you don't append **print=silent** to the url, if you use POST the returning value becomes the name of the snapshot, if PUT you get the data you just sent. If print=silent is provided, you get just NULL because the backend never sends an output.
```python
from firebase import firebase
firebase = firebase.FirebaseApplication('https://your_storage.firebaseio.com', None)
new_user = 'Dave'
result = firebase.post('/users', new_user, {'print': 'pretty'}, {'X_FANCY_HEADER': 'VERY FANCY'})
print(result)
>> {u'name': u'<UID Hash>'}
result = firebase.post('/users', new_user, {'print': 'silent'}, {'X_FANCY_HEADER': 'VERY FANCY'})
print(result == None)
>> True
```
Deleting data is relatively easy compared to other actions. You just set the url and that's all. Backend sends no output as a result of a delete operation.
```python
from firebase import firebase
firebase = firebase.FirebaseApplication('https://your_storage.firebaseio.com', None)
firebase.delete('/users', '3')
# Dave goes away.
```
## Authentication
Authentication in Firebase is nothing but to simply creating a token that conforms to the JWT standards and, putting it into the querystring with the name **auth**. The library creates that token for you so you never end up struggling with constructing a valid token on your own. If the data has been protected against write/read operations with some security rules, the backend sends an appropriate error message back to the client with the status code **403 Forbidden**.
```python
from firebase import firebase
firebase = firebase.FirebaseApplication('https://your_storage.firebaseio.com', authentication=None)
result = firebase.get('/users', None, {'print': 'pretty'})
print(result)
>> {'error': 'Permission denied.'}
authentication = firebase.FirebaseAuthentication('THIS_IS_MY_SECRET', 'Joe@Tilsed.com', extra={'id': 123})
firebase.authentication = authentication
print(authentication.extra)
>> {'admin': False, 'debug': False, 'email': 'Joe@Tilsed.com', 'id': 123, 'provider': 'password'}
user = authentication.get_user()
print(user.firebase_auth_token)
>> "eyJhbGciOiAiSFMyNTYiLCAidHlwIjogIkpXVCJ9.eyJhZG1pbiI6IGZhbHNlLCAiZGVidWciOiBmYWxzZSwgIml
hdCI6IDEzNjE5NTAxNzQsICJkIjogeyJkZWJ1ZyI6IGZhbHNlLCAiYWRtaW4iOiBmYWxzZSwgInByb3ZpZGVyIjog
InBhc3N3b3JkIiwgImlkIjogNSwgImVtYWlsIjogIm96Z3VydnRAZ21haWwuY29tIn0sICJ2IjogMH0.lq4IRVfvE
GQklslOlS4uIBLSSJj88YNrloWXvisRgfQ"
result = firebase.get('/users', None, {'print': 'pretty'})
print(result)
>> {'1': 'Joe Tilsed', '2': 'Sydney Cox'}
```
## Concurrency
The interface heavily depends on the standart **multiprocessing** library when concurrency comes in. While creating an asynchronous call, an on-demand process pool is created and, the async method is executed by one of the idle process inside the pool. The pool remains alive until the main process dies. So every time you trigger an async call, you always use the same pool. When the method returns, the pool process ships the returning value back to the main process within the callback function provided.
```python
import json
from firebase import firebase
from firebase import jsonutil
firebase = firebase.FirebaseApplication('https://your_storage.firebaseio.com', authentication=None)
def log_user(response):
with open('/tmp/users/%s.json' % response.keys()[0], 'w') as users_file:
users_file.write(json.dumps(response, cls=jsonutil.JSONEncoder))
firebase.get_async('/users', None, {'print': 'pretty'}, callback=log_user)
```
###### # That's all folks...
Raw data
{
"_id": null,
"home_page": "https://bitbucket.org/joetilsed/firebase/",
"name": "firebase",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "firebase python",
"author": "Joe Tilsed",
"author_email": "Joe@Tilsed.com",
"download_url": "https://files.pythonhosted.org/packages/a4/6f/ec2c7207f53115d39ae2a5bdb04b0df3cf341d6cc52cacbed0a315e02407/firebase-4.0.1.tar.gz",
"platform": null,
"description": "# Python interface to the Google's Firebase REST APIs\r\n###### Author: [Joe Tilsed](http://linkedin.com/in/joetilsed) | Created: 09.02.2019 | Last Updated: 22.02.2023 | Version 4.0.1\r\n\r\n# Firebase\r\n\r\nPython interface to the Google's Firebase REST APIs\r\n\r\n[](http://www.firebase.com)\r\n\r\n## Installation\r\n\r\n $ pip install firebase\r\n\r\n## Getting Started\r\n\r\nYou can fetch any of your data in JSON format by appending '.json' to the end of the URL in which your data resides and, then send an HTTPS request through your browser. Like all other REST specific APIs, Firebase offers a client to update(PATCH, PUT), create(POST), or remove(DELETE) his stored data along with just to fetch it.\r\n\r\nThe library provides all the corresponding methods for those actions in both synchronous and asynchronous manner. You can just start an asynchronous GET request with your callback function, and the method\r\n\r\n\r\nTo fetch all the users in your storage simply do the following:\r\n\r\n```python\r\nfrom firebase import firebase\r\n\r\nfirebase = firebase.FirebaseApplication('https://your_storage.firebaseio.com', None)\r\nresult = firebase.get('/users', None)\r\nprint(result)\r\n\r\n>> {'1': 'Joe Tilsed', '2': 'Sydney Cox'}\r\n```\r\n\r\n\r\nThe second argument of **get** method is the name of the snapshot. Thus, if you leave it NULL, you get the data in the URL **/users.json**. Besides, if you set it to **1**, you get the data in the url **/users/1.json**. In other words, you get the user whose ID equals to 1.\r\n\r\n```python\r\nfrom firebase import firebase\r\n\r\nfirebase = firebase.FirebaseApplication('https://your_storage.firebaseio.com', None)\r\nresult = firebase.get('/users', '1')\r\nprint(result)\r\n\r\n>> {'1': 'Joe Tilsed'}\r\n```\r\n\r\nYou can also provide extra query parameters that will be appended to the url or extra key-value pairs sent in the HTTP header.\r\n\r\n```python\r\nfrom firebase import firebase\r\n\r\nfirebase = firebase.FirebaseApplication('https://your_storage.firebaseio.com', None)\r\nresult = firebase.get('/users/2', None, {'print': 'pretty'}, {'X_FANCY_HEADER': 'VERY FANCY'})\r\nprint(result)\r\n\r\n>> {'2': 'Sydney Cox'}\r\n```\r\n\r\nCreating new data requires a POST or PUT request. Assuming you don't append **print=silent** to the url, if you use POST the returning value becomes the name of the snapshot, if PUT you get the data you just sent. If print=silent is provided, you get just NULL because the backend never sends an output.\r\n\r\n```python\r\nfrom firebase import firebase\r\n\r\nfirebase = firebase.FirebaseApplication('https://your_storage.firebaseio.com', None)\r\nnew_user = 'Dave'\r\n\r\nresult = firebase.post('/users', new_user, {'print': 'pretty'}, {'X_FANCY_HEADER': 'VERY FANCY'})\r\nprint(result)\r\n\r\n>> {u'name': u'<UID Hash>'}\r\n\r\nresult = firebase.post('/users', new_user, {'print': 'silent'}, {'X_FANCY_HEADER': 'VERY FANCY'})\r\nprint(result == None)\r\n\r\n>> True\r\n```\r\n\r\nDeleting data is relatively easy compared to other actions. You just set the url and that's all. Backend sends no output as a result of a delete operation.\r\n\r\n```python\r\nfrom firebase import firebase\r\n\r\nfirebase = firebase.FirebaseApplication('https://your_storage.firebaseio.com', None)\r\nfirebase.delete('/users', '3')\r\n\r\n# Dave goes away.\r\n```\r\n\r\n## Authentication\r\n\r\nAuthentication in Firebase is nothing but to simply creating a token that conforms to the JWT standards and, putting it into the querystring with the name **auth**. The library creates that token for you so you never end up struggling with constructing a valid token on your own. If the data has been protected against write/read operations with some security rules, the backend sends an appropriate error message back to the client with the status code **403 Forbidden**.\r\n\r\n```python\r\nfrom firebase import firebase\r\n\r\nfirebase = firebase.FirebaseApplication('https://your_storage.firebaseio.com', authentication=None)\r\nresult = firebase.get('/users', None, {'print': 'pretty'})\r\n\r\nprint(result)\r\n\r\n>> {'error': 'Permission denied.'}\r\n\r\nauthentication = firebase.FirebaseAuthentication('THIS_IS_MY_SECRET', 'Joe@Tilsed.com', extra={'id': 123})\r\nfirebase.authentication = authentication\r\nprint(authentication.extra)\r\n\r\n>> {'admin': False, 'debug': False, 'email': 'Joe@Tilsed.com', 'id': 123, 'provider': 'password'}\r\n\r\nuser = authentication.get_user()\r\nprint(user.firebase_auth_token)\r\n\r\n>> \"eyJhbGciOiAiSFMyNTYiLCAidHlwIjogIkpXVCJ9.eyJhZG1pbiI6IGZhbHNlLCAiZGVidWciOiBmYWxzZSwgIml\r\n hdCI6IDEzNjE5NTAxNzQsICJkIjogeyJkZWJ1ZyI6IGZhbHNlLCAiYWRtaW4iOiBmYWxzZSwgInByb3ZpZGVyIjog\r\n InBhc3N3b3JkIiwgImlkIjogNSwgImVtYWlsIjogIm96Z3VydnRAZ21haWwuY29tIn0sICJ2IjogMH0.lq4IRVfvE\r\n GQklslOlS4uIBLSSJj88YNrloWXvisRgfQ\"\r\n\r\nresult = firebase.get('/users', None, {'print': 'pretty'})\r\nprint(result)\r\n\r\n>> {'1': 'Joe Tilsed', '2': 'Sydney Cox'}\r\n```\r\n\r\n## Concurrency\r\n\r\nThe interface heavily depends on the standart **multiprocessing** library when concurrency comes in. While creating an asynchronous call, an on-demand process pool is created and, the async method is executed by one of the idle process inside the pool. The pool remains alive until the main process dies. So every time you trigger an async call, you always use the same pool. When the method returns, the pool process ships the returning value back to the main process within the callback function provided.\r\n\r\n```python\r\nimport json\r\n\r\nfrom firebase import firebase\r\nfrom firebase import jsonutil\r\n\r\nfirebase = firebase.FirebaseApplication('https://your_storage.firebaseio.com', authentication=None)\r\n\r\ndef log_user(response):\r\n with open('/tmp/users/%s.json' % response.keys()[0], 'w') as users_file:\r\n users_file.write(json.dumps(response, cls=jsonutil.JSONEncoder))\r\n\r\nfirebase.get_async('/users', None, {'print': 'pretty'}, callback=log_user)\r\n```\r\n\r\n###### # That's all folks...\r\n",
"bugtrack_url": null,
"license": "",
"summary": "Python interface to the Google's Firebase REST APIs",
"version": "4.0.1",
"project_urls": {
"Homepage": "https://bitbucket.org/joetilsed/firebase/"
},
"split_keywords": [
"firebase",
"python"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "56d13ae55fbac562398ea144ba93869a9d176d0fe55f7f5a870098b396d33c88",
"md5": "b77ed2c4e94f4ee32fce3e365bea5bc9",
"sha256": "5d91cbd8cb572a0cd3ea404e108b20fe58548ef8bcf464c83077367835b175f4"
},
"downloads": -1,
"filename": "firebase-4.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b77ed2c4e94f4ee32fce3e365bea5bc9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 12396,
"upload_time": "2023-02-22T09:05:35",
"upload_time_iso_8601": "2023-02-22T09:05:35.149191Z",
"url": "https://files.pythonhosted.org/packages/56/d1/3ae55fbac562398ea144ba93869a9d176d0fe55f7f5a870098b396d33c88/firebase-4.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a46fec2c7207f53115d39ae2a5bdb04b0df3cf341d6cc52cacbed0a315e02407",
"md5": "f20c49b27d3512ba8388e57af318e7f7",
"sha256": "46ddd748c2a5e064d38b76cc6c01fc6fdc5df49184d8774c1c178ba79746121c"
},
"downloads": -1,
"filename": "firebase-4.0.1.tar.gz",
"has_sig": false,
"md5_digest": "f20c49b27d3512ba8388e57af318e7f7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 12934,
"upload_time": "2023-02-22T09:05:37",
"upload_time_iso_8601": "2023-02-22T09:05:37.351421Z",
"url": "https://files.pythonhosted.org/packages/a4/6f/ec2c7207f53115d39ae2a5bdb04b0df3cf341d6cc52cacbed0a315e02407/firebase-4.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-02-22 09:05:37",
"github": false,
"gitlab": false,
"bitbucket": true,
"codeberg": false,
"bitbucket_user": "joetilsed",
"bitbucket_project": "firebase",
"lcname": "firebase"
}
JSON