Metadata-Version: 1.0
Name: commitment
Version: 1.0.0
Summary: Python 3 wrapper to push data to a GitHub repo using the GitHub contents api
Home-page: https://github.com/chris48s/commitment/
Author: chris48s
Author-email: UNKNOWN
License: MIT
Description-Content-Type: UNKNOWN
Description: commitment
        ==========
        
        |Build Status| |Coverage Status|
        
        Python 3 wrapper to push data to a GitHub repo using the GitHub
        `contents api <https://developer.github.com/v3/repos/contents/>`__
        
        Installation
        ------------
        
        ``pip install commitment``
        
        Platform Support
        ----------------
        
        ``commitment`` is tested under Python 3.4, 3.5 and 3.6
        
        Usage
        -----
        
        Generate a GitHub API key: https://github.com/settings/tokens
        
        .. code:: python
        
            from commitment import GitHubCredentials, GitHubClient
        
            credentials = GitHubCredentials(
                repo="myuser/somerepo",
                branch='master',
                name="myuser",
                email="someone@example.com",
                api_key="f00b42",
            )
        
            client = GitHubClient(credentials)
        
            g.push_file('Hello World!', 'directory/filename.txt', 'my commit message')
        
        Licensing
        ---------
        
        ``commitment`` is made available under the MIT License
        
        .. |Build Status| image:: https://travis-ci.org/chris48s/commitment.svg?branch=master
           :target: https://travis-ci.org/chris48s/commitment
        .. |Coverage Status| image:: https://coveralls.io/repos/github/chris48s/commitment/badge.svg?branch=master
           :target: https://coveralls.io/github/chris48s/commitment?branch=master
        
Platform: UNKNOWN
