Metadata-Version: 1.0
Name: notehub
Version: 0.2
Summary: A simple wrapper for the Notehub.org API.
Home-page: https://github.com/seanwatson/notehub
Author: Sean Watson
Author-email: UNKNOWN
License: MIT
Description: notehub
        =======
        
        Installation
        ------------
        
        To install with pip run:
        
            pip install notehub
        
        Or you can download the source and run:
        
            python setup.py install
        
        *Running these commands may require administrator privledges.*
        
        Getting Started
        ---------------
        
        A basic python wrapper for the Notehub.org API that simplifies much of the work
        needed to make a call. The wrapper handles the work of adding necessary
        parameters, hashing passwords, generating signatures, encoding the data and
        checking response codes.
        
        **You will need a PID and PSK from http://notehub.org/api**
        **in order to use the create\_note and update\_note methods.**
        
        Example use:
        
            from notehub import Notehub
            from notehub import NotehubError
        
            PID = 'example_pid' # Replace with your PID
            PSK = 'example_psk' # Replace with your PSK
        
            nh = Notehub(PID, PSK)
        
            # get_note
            try:
                note = nh.get_note('2014 1 18 test-7')
                print(note)
            except NotehubError as e:
                print(e)
        
            # create_note
            note_text = 'Test note 123.'
            try:
                note = nh.create_note(note_text)
                print(note)
            except NotehubError as e:
                print(e)
        
            # create_note with password
            note_text = 'Test note 123.'
            password = 'abc123'
            try:
                note = nh.create_note(note_text, password)
                print(note)
            except NotehubError as e:
                print(e)
        
            # update_note
            note_id = '2014 1 18 test-7'
            new_note_text = 'New note text.'
            password = 'abc123'
            try:
                note = nh.update_note(note_id, new_note_text, password)
                print(note)
            except NotehubError as e:
                print(e)
        
        License
        -------
        
        The MIT License (MIT)
        
        Copyright (c) 2014 Sean Watson
        
        Permission is hereby granted, free of charge, to any person obtaining a copy of
        this software and associated documentation files (the "Software"), to deal in
        the Software without restriction, including without limitation the rights to
        use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
        the Software, and to permit persons to whom the Software is furnished to do so,
        subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
        FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
        COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
        IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
        CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
        
Keywords: notehub
Platform: UNKNOWN
