Metadata-Version: 2.1
Name: nodifly
Version: 1.0.9
Summary: Nodifly - Real Time Notifications
Home-page: https://github.com/stephenjhsu/nodifly
Author: Stephen Hsu
Author-email: nodiflycontact@gmail.com
License: UNKNOWN
Description: # Nodifly Python Library
        ========================
        
        ## Installation
        
        To install the current release: 
        
        ```
        pip install --upgrade nodifly 
        ```
        
        ### Requirements 
        
        - Python 2.7+ or Python 3.4+
        
        ## Usage and Starting Out
        
        The library needs to be configured with your account's secret key which is available 
        in your [Nodifly Settings](https://nodifly.com/logged_settings). 
        
        After you register, grab your `Access Key` and `Access Secret` from the keys and tokens tab. 
        
        First, you'll want to import Nodifly 
        
        ```
        from nodifly.auth import NodiflyAuth
        ```
        
        ## Authentication 
        
        Now, you can create a Nodifly instance with your access key and access secret. 
        
        ```
        ACCESS_KEY = 'YOUR KEY HERE'
        ACCESS_SECRET = 'YOUR SECRET HERE'
        
        nodifly = NodiflyAuth(ACCESS_KEY, ACCESS_SECRET)
        ```
        
        And then depending on if you're using terminal or in Jupyter notebooks, you can:
        
        ## Terminal 
        
        After including the instantiated Nodifly instance at the top of the 
        
        Within terminal you can call it as 
        
        ```
        nodifly your_file.py - [text, record, email]
        ```
        
        ## Jupyter Notebooks 
        
        Within Jupyter Notebooks, you can use it in a per cell use case.
        
        ```
        nodifly.nodifly(alias='YOUR_ALIAS', kind='text, record, email')
        
        YOUR CODE HERE
        ```
        
        ## Dashboards and Analysis
        
        image
        
        ## Questions and Comments 
        
        We're actively looking to improve and expand Nodifly - if you have any questions or suggestions, please don't hesitate
        to reach us at nodiflycontact@gmail.com 
        
        Thank you!
        
        
        
        
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
