Metadata-Version: 1.0
Name: github3.py
Version: 0.1a1
Summary: Python wrapper for the GitHub API (http://developer.github.com/v3)
Home-page: https://github3py.readthedocs.org
Author: Ian Cordasco
Author-email: graffatcolmingov@gmail.com
License: Redistribution and use in source and binary forms, with or without 
modification, are permitted provided that the following conditions are 
met:

1. Redistributions of source code must retain the above copyright 
notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright 
notice, this list of conditions and the following disclaimer in the 
documentation and/or other materials provided with the distribution.
3. The name of the author may not be used to endorse or promote products 
derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 
IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, 
INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES 
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 
STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN 
ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
POSSIBILITY OF SUCH DAMAGE.

Description: github3.py
        ==========
        
        Eventually this will be a python module to access the GitHub v3 API.
        
        This is not stable yet and there is no backwards compatibility yet. There will 
        likely be some changes which change behavior in the near future.
        
        Easy Cloning
        ------------
        
        Assuming you have git 1.7.x (although I'm not entirely certain what version
        it was introduced in) you can perform ``git clone --recursive
        git://github.com/sigmavirus24/github3.py.git github3.py`` to clone this 
        and the submodule at the same time. Otherwise you have to do:
        
        ::
        
            $ git clone git://github.com/sigmavirus24/github3.py.git
            $ cd github3.py
            $ git submodule init
            $ git submodule update
        
        Dependencies
        ------------
        
        - requests_  by Kenneth Reitz
          
        .. _requests: https://github.com/kennethreitz/requests
        
        In Progress
        -----------
        
        - Repositories: **done**
        
          - Downloads_: **stalled** [#]_
        
        .. _Downloads: http://developer.github.com/v3/repos/downloads/
        
        .. [#] Creating a download via Amazon S3 seems to always return an invalid
               multipart/form-data POST request.
        
        License
        -------
        
        Modified BSD license_
        
        .. _license:
        
        Examples
        --------
        
        See the docs_ for more detailed examples.
        
        .. _docs: http://github3py.readthedocs.org/en/latest/index.html#more-examples
        
        ::
        
          >>> from github3 import login
          >>> gh = login(username, password)
          >>> issue = gh.issue('sigmavirus24', 'Todo.txt-python', 17)
          >>> issue.html_url
          u'https://github.com/sigmavirus24/Todo.txt-python/issues/17'
          >>> issue.state
          u'open'
          >>> events = issue.list_events()
          >>> events
          [<Issue Event [#17 - subscribed - sigmavirus24]>, <Issue Event [#17 - assigned - sigmavirus24]>,
           <Issue Event [#17 - referenced - sigmavirus24]>]
          >>> events[0].actor
          <User [sigmavirus24:None]>
          >>> events[0].issue
          <Issue [sigmavirus24/Todo.txt-python #17]>
          >>> events[0].closed_at
          >>> events[0].event
          u'subscribed'
        
        ::
        
          >>> from github3 import login
          >>> g = login(username, password)
          >>> repo = g.repository('sigmavirus24', 'Todo.txt-python')
          >>> sha = repo.create_blob('Testing blob creation', 'utf-8')
          >>> sha
          u'57fad9a39b27e5eb4700f66673ce860b65b93ab8'
          >>> blob = repo.blob(sha)
          >>> blob.content
          u'VGVzdGluZyBibG9iIGNyZWF0aW9u\n'
          >>> blob.decoded
          u'Testing blob creation'
          >>> blob.encoding
          u'base64'
        
        ::
        
          >>> from github3 import login
          >>> g = login(username, password)
          >>> repo = g.repository('sigmavirus24', 'github3.py')
          >>> tag = repo.tag('cdba84b4fede2c69cb1ee246b33f49f19475abfa')
          >>> tag
          <Tag [cdba84b4fede2c69cb1ee246b33f49f19475abfa]>
          >>> tag.object.sha
          u'24ea44d302c6394a0372dcde8fd8aed899c0034b'
          >>> tag.object.type
          u'commit'
        
        Author
        ------
        
        Ian Cordasco (sigmavirus24)
        
        
        0.1: 2012-06-xx
        +++++++++++++++
        
        - Support for the complete GitHub API
        
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: License :: OSI Approved
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.2
Classifier: Programming Language :: Python :: Implementation :: CPython
