Metadata-Version: 1.0
Name: pytidyclub
Version: 0.0.2
Summary: A simple Python wrapper for the TidyClub API
Home-page: http://github.com/kyerussell/pytidyclub
Author: Kye Russell
Author-email: me@kye.id.au
License: MIT
Description: Welcome to pytidyclub!
        ^^^^^^^^^^^^^^^^^^^^^
        pytidyclub is a simple Python wrapper for the TidyClub API.
        
        TidyClub_ is a powerful online tool that removes a lot of hassle from the management of your
        club or association. Unfortunately, TidyClub doesn't do everything, but they provide an API_
        which you can use to extend it. pytidyclub is a Python wrapper for this API, which makes
        creating Python projects that interface with the TidyClub API easier.
        
        pytidyclub is **not** a complete implementation of the TidyClub _API.
        
        Installing
        ^^^^^^^^^^
        You can install pytidyclub with ``pip``::
        
            pip install pytidyclub
            
        Example
        ^^^^^
        
        ::
        
            from pytidyclub import pytidyclub
            
            club = pytidyclub.Club(
                slug = default,
                client_id = "12345J",
                client_secret = "54321F"
            )
            
            # Authenticate as a user.
            print club.auth_authcode_get_url("https://sso.example.com/oauth/tidyclub/callback")
            club.auth_authcode_exchange_code("555555", "https://sso.example.com/oauth/tidyclub/callback")
        
            # Get all contacts.
            contacts = club.get_contacts()
            
            # Search for contacts
            contacts = club.get_contacts("Kye Russell")
        
        
        .. _TidyClub: http://tidyclub.com
        .. _API: http://dev.tidyclub.com
Platform: UNKNOWN
