Welcome to simplegist’s documentation!

Helps in carrying out easy workflow for maintaining gists

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 comments of any gist, make/edit a comment on a gist, delete a comment

Installation

$ pip install simplegist

Or download it from here and then,

$ cd /to/this/directory/
$ python install setup.py

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.

Creating an Instance

# if USERNAME and API_TOKEN are not provided in config.py
GHgist = Simplegist(username='USERNAME',api_token='API_TOKEN')

# else
GHgist = Simplegist()

Example Usage

Below is an example to getting started with using GistAPI and its useful functionalities.

from simplegist import SimpleGist

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

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

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

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

# Lists all the comments on gist named '_GISTNAME' of user '_USERNAME'
GHgist.comments().listall(user='_USERNAME',name='_GISTNAME')

# ...and many more...

Contents:

• Creating a gist
  • Creating a Gist with all arguments create(params)
  • Creating a Gist with required argument only create(params)
• Managing authenticated user’s gists
  • Listing all the Gists profile().listall()
  • Listing the required number of Gists profile().list(integar)
  • Get GistName profile().getgist(id='_GISTID')
  • Fetch Gist-Link, Clone-Link and Embed-Script-Link of your gist profile().links(id/name)
  • Fetching the contents of a Gist profile().content(params)
  • Listing the starred Gists profile().starred()
  • Get GistName profile().getgist(id='_GISTID')
  • Editing a Gist profile().edit(params)
  • Getting a GistName using GistID profile().getMyID(params)
  • Deleting a Gist profile().delete(params)
• Actions on gists
  • Useful Information for below mentioned methods
  • Other Docs
• Search User’s gists
  • Listing all the Gists search('_USERNAME').listall()
  • Listing the required number of Gists search('_USERNAME').list(integar)
  • Fetching the contents of a Gist using GistName search('_USERNAME').content(params)
  • Fetching the contents of any Gist using GistID search('').content(id='_GISTID')
  • Fetch GistName search('').getgist(id='_GISTID')
  • Fetch Gist-Link, Clone-Link and Embed-Script-Link of searched gist search('_USERNAME/EMPTY').links(id/name)
• GistAPI for Comments Section
  • Listing all the comments on your Gists comments().listall(params)
  • Fetch a single comment on a Gist comments().get(params)
  • Post/Create a comment on a Gist comments().create(params)
  • Edit a comment on a Gist comments().edit(params)
  • Delete a comment on a GIst comments().delete(params)

Related Docs

• Creating a gist
• Managing authenticated user’s gists
• Actions on gists
• Search User’s gists
• GistAPI for Comments Section