Metadata-Version: 1.1
Name: commitment
Version: 2.0.0
Summary: An incomplete Python 3 wrapper for the GitHub 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| |PyPI Version| |License| |Python
        Support|
        
        An incomplete Python 3 wrapper for the `GitHub
        API <https://developer.github.com/v3/>`__.
        
        Note this project does not aim to provide a complete abstraction over
        the GitHub API - just a few high-level convenience methods for pushing
        data to a GitHub repo.
        
        Installation
        ------------
        
        ``pip install commitment``
        
        Usage
        -----
        
        Generate a GitHub API key: https://github.com/settings/tokens
        
        .. code:: python
        
            from commitment import GitHubCredentials, GitHubClient
        
            credentials = GitHubCredentials(
                repo="myuser/somerepo",
                name="myuser",
                email="someone@example.com",
                api_key="f00b42",
            )
        
            client = GitHubClient(credentials)
        
            client.create_branch('my_new_branch', base_branch='master')
            client.push_file('Hello World!', 'directory/filename.txt', 'my commit message', branch='my_new_branch')
            client.open_pull_request('my_new_branch', 'title', 'body', base_branch='master')
        
        .. |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
        .. |PyPI Version| image:: https://img.shields.io/pypi/v/commitment.svg
        .. |License| image:: https://img.shields.io/pypi/l/commitment.svg
        .. |Python Support| image:: https://img.shields.io/pypi/pyversions/commitment.svg
        
        
Platform: UNKNOWN
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
