Skip to main content

Python wrapper for Gist

Project description

Python wrapper for GitHub's Gist API.

Latest Version Downloads

Features

  • Create Gists and get url, script and clone link on success (can be used for copy-paste purpose too)
  • View one’s Gist(s) - name, description and it’s content
  • Edit and Delete a gist
  • Search Gist(s) of any user; fork, star and unstar them
  • List all comments on any Gist, put/edit/delete a comment on a Gist

Installation

$ pip install simplegist

Download here and run python setup.py install after changing directory to /simplegist

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 simplegist import Simplegist

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

# creating gist and getting url, script and clone link
ghGist.create(name='_GISTNAME', description='_ANY_DESCRIPTION', public=1, content='_CONTENT_GOES_HERE')

# List down all the names of authenticated user's Gists
ghGist.profile().listall()

# List down only the names of recent two Gists of user '_USERNAME'
ghGist.search('_USERNAME').list(2)

# List down all the comments on gist named '_GISTNAME' of user 'USERNAME'
ghGist.comments().listall(user='_USERNAME', name='_GISTNAME')

# ...and many more...

Full Usage and Documentation

Visit here READTHEDOCS or PYTHONHOSTED

Patches and suggestions are welcome

$ git clone https://github.com/softvar/simplegist.git
$ cd simplegist

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-1.0.1.tar.gz (6.0 kB view hashes)

Uploaded source

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page