<commit_before>Python Firebasin 0.1
====================

*Please note: Very little testing has been done on Firebasin, it is considered experimental until future notice.*

Firebasin is a reimplementation of the [Firebase Javascript SDK](https://www.firebase.com/docs/javascript/firebase/index.html) in pure Python. Firebasin aims to have an interface identical to the Javascript SDK. As such, the Firebase Javascript docs can be used as temporary docs for Firebasin as the interface is identical. However, it should be noted that the implementation and internal structure of Firebasin differs greatly from the Javascript SDK. This is done intentionally as an attempt to implement things as pythonically as possible.

Compatible Method List
-----
**Firebase**
* Firebase( )			
* auth( )				
* unauth( )				
* child( )				
* parent( )				
* root( )				
* name( )				
* toString( )			
* set( )				
* update( )				
* remove( )							
* setWithPriority( )	
* setPriority( )	
* push( )		
* on( )	
* once( )		
* off( )
* limit( )				
* startAt( )			
* endAt( )								

**onDisconnect**
* set( )				
* setWithPriority( )	
* update( )				
* remove( )				
* cancel( )				

**DataSnapshot**
* val( )				
* child( )				
* forEach( )			
* hasChild( )			
* hasChildren( )		
* name( )				
* numChildren( )					
* getPriority( )		
* exportVal( )	
* ref( )		

Incompatible Method List
-----
**Firebase**	
* transaction( )	

			<commit_msg>Cleaned up README<commit_after>Python Firebasin 0.1
====================

*Please note: All "compatible" methods have been tested as functional, but not extensively. There is limited functionality for query related methods.*

Firebasin is a reimplementation of the [Firebase Javascript SDK](https://www.firebase.com/docs/javascript/firebase/index.html) in pure Python. Firebasin aims to have an interface identical to the Javascript SDK. As such, the Firebase Javascript docs can be used as temporary docs for Firebasin as the interface is identical. However, it should be noted that the implementation and internal structure of Firebasin differs greatly from the Javascript SDK. This is done intentionally as an attempt to implement things as pythonically as possible.

Compatible Method List
-----
**Firebase**
* Firebase( )			
* auth( )				
* unauth( )				
* child( )				
* parent( )				
* root( )				
* name( )				
* toString( )			
* set( )				
* update( )				
* remove( )							
* setWithPriority( )	
* setPriority( )	
* push( )		
* on( )	
* once( )		
* off( )								

**onDisconnect**
* set( )				
* setWithPriority( )	
* update( )				
* remove( )				
* cancel( )				

**DataSnapshot**
* val( )				
* child( )				
* forEach( )			
* hasChild( )			
* hasChildren( )		
* name( )				
* numChildren( )					
* getPriority( )		
* exportVal( )	
* ref( )		

Incompatible/Incomplete Method List
-----
**Firebase**	
* transaction( )
* limit( )
* startAt( )
* endAt( )	

			
{'fraction_non_alphanumeric': 0.1285862426546837, 'fraction_numerical': 0.00138264777048047, 'mean_word_length': 2.921409214092141, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 2, 'lorem ipsum': 0, 'www.': 2, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '6008381', 'n_tokens_mistral': 1075, 'n_tokens_neox': 877, 'n_words': 288}