Skip to main content

Python wrapper for Gist

Project description

Python wrapper for GitHub's Gist.

Features

  • Creating gists returning the url, script and clone link for copy-paste purpose

  • Checkout one’s gists - Name(s), Description and Content

  • Edit and Delete a gist

  • Search GitHub user’s gist - fork, star and unstar them

  • List-all comments of any gist, make/edit a comment on a gist, delete a comment

Installation

$ pip install gists

Generating Github API Access Token

Go to Github’s Account settings > Applications Create a new token and use it for making API requests instead of password

Example Usage

from gist import Gist

GHgist = Gist(username='USERNAME',api_token='API_TOKEN')
# or provide USERNAME and API_TOKEN in config.py file, so just, GHgist = Gist()

# creating gist and returning url, script, clone link
GHgist.create(name='Test.py', description='just testing it', public=1, content='print "Yay! Test Passed" ')

# Lists all the names of authenticated user's gists
GHgist.profile().listall()

# Lists only the names of recent two gists of user 'softvar'
GHgist.search('softvar').list(2)

# Lists all the comments on gist named 'bootstrap-min.css' of user 'softvar'
GHgist.comments().listall(user='softvar',name='bootstrap-min.css')

# ...and many more...

Patches and suggestions are welcomed

$ git clone https://github.com/softvar/GistApi-Wrapper-python.git
$ cd GistApi-Wrapper-python

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

simplegist-0.1.tar.gz (5.2 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page