bump to a stable version 1.0.0, fixed typos

Author: softvar

README.rst

@@ -11,23 +11,30 @@ Python wrapper for ``GitHub's Gist API``.
 .. |Downloads| image:: https://pypip.in/d/simplegist/badge.png
     :target: https://pypi.python.org/pypi//simplegist/
 
+|Latest Version| |Downloads|
+
+.. |Latest Version| image:: https://img.shields.io/pypi/v/simplegist.svg
+    :target: https://pypi.python.org/pypi/simplegist
+
+.. |Downloads| image:: https://img.shields.io/pypi/dm/simplegist.svg
+    :target: https://pypi.python.org/pypi/simplegist
 
 Features
 --------
 
-* Creating gists returning the url, script and clone link for copy-paste purpose
-* Checkout one's gists - Name(s), Description and Content
+* 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 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 
+* 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
 -------------
 .. code-block:: bash
 
     $ pip install simplegist
 
-Download `here <https://github.com/softvar/simplegist/tarball/0.3.2>`_ and run ``python setup.py install`` after changing directory to ``/simplegist``
+Download `here <https://github.com/softvar/simplegist/tarball/1.0.0>`_ and run ``python setup.py install`` after changing directory to ``/simplegist``
 
 Generating Github API Access Token
 ----------------------------------
@@ -41,20 +48,20 @@ 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()
+    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')
 
-    # creating gist and returning url, script, 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()
 
-    # Lists 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)
 
-    # 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')
+    # List down all the comments on gist named '_GISTNAME' of user 'USERNAME'
+    ghGist.comments().listall(user='_USERNAME', name='_GISTNAME')
 
     # ...and many more...
 
@@ -63,8 +70,8 @@ Full Usage and Documentation
 
 Visit here `READTHEDOCS <https://simplegist.readthedocs.org/en/latest/>`_ or `PYTHONHOSTED <http://pythonhosted.org/simplegist/>`_
 
-Patches and suggestions are welcomed
-------------------------------------
+Patches and suggestions are welcome
+-----------------------------------
 
 .. code-block:: bash
 

docs/index.rst

@@ -14,15 +14,15 @@ Features
 * 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 
+* List comments of any gist, make/edit a comment on a gist, delete a comment
 
 Installation
 ------------
 .. code-block:: bash
 
     $ pip install simplegist
 
-Or download it from `here <https://github.com/softvar/GistApi-Wrapper-python/tarball/0.3.2>`_ and then,
+Or download it from `here <https://github.com/softvar/GistApi-Wrapper-python/tarball/1.0.0>`_ and then,
 
 .. code-block:: bash
 
@@ -44,7 +44,7 @@ Creating an Instance
 	GHgist = Simplegist(username='USERNAME',api_token='API_TOKEN')
 
 	# else
-	GHgist = Simplegist() 
+	GHgist = Simplegist()
 
 Example Usage
 -------------
@@ -56,17 +56,17 @@ Below is an example to getting started with using GistAPI and its useful functio
     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') 
+    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') 
+    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' 
+    # 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')
 

docs/manage.rst

@@ -3,7 +3,7 @@ Managing authenticated user's gists
 
 .. warning::
 
-	user must be authenticated 
+	user must be authenticated
 
 
 Listing all the Gists ``profile().listall()``
@@ -19,7 +19,7 @@ Fetch all the GistsNames.
 
 	GHgist.profile().listall()
 
-Listing the required number of Gists ``profile().list(integar)``
+Listing the required number of Gists ``profile().list(integer)``
 ----------------------------------------------------------------
 
 Fetch only the limited number of Gists ``list(4)``.
@@ -28,8 +28,8 @@ Fetch only the limited number of Gists ``list(4)``.
 
 	Input
 
-		integar
-			``integar`` is **required** as an argument which will limit the number of Gists to be listed.
+		integer
+			``integer`` is **required** as an argument which will limit the number of Gists to be listed.
 
 .. code-block:: python
 
@@ -58,7 +58,7 @@ Fetch Gist-Link, Clone-Link and Embed-Script-Link of your gist ``profile().links
 
 	GHgist.profile('YOURUSERNAME').links(id='_GISTID')
 	GHgist.profile('YOURUSERNAME').links(name='_GISTNAME')
-	
+
 Fetching the contents of a Gist ``profile().content(params)``
 -------------------------------------------------------------
 
@@ -67,7 +67,7 @@ Fetch the contents of a Gist by name (GISTNAME) ``content(name='_GISTNAME')``.
 .. code-block:: python
 
 	GHgist.profile().content(name='_GISTNAME')
-	
+
 Fetch by id (GISTID)
 
 .. code-block:: python
@@ -126,7 +126,7 @@ Edit a Gist by providing either GistName or GistID, and content.
 	GHgist.profile().edit(description='_NEW_DESCRIPTION',name='_GISTNAME',content='_UPDATED_CONETNT_GOES_HERE')
 
 	# with required arguments
-	GHgist.profile().edit(id='_GISTID',content='_UPDATED_CONTENT_GOES_HERE')	
+	GHgist.profile().edit(id='_GISTID',content='_UPDATED_CONTENT_GOES_HERE')
 
 Getting a GistName using GistID ``profile().getMyID(params)``
 -------------------------------------------------------------

docs/searching.rst

@@ -14,7 +14,7 @@ Fetch all the GistsNames of a Github User.
 
 	GHgist.search('_USERNAME').listall()
 
-Listing the required number of Gists ``search('_USERNAME').list(integar)``
+Listing the required number of Gists ``search('_USERNAME').list(integer)``
 --------------------------------------------------------------------------
 
 Fetch only the limited number of Gists.
@@ -23,13 +23,13 @@ Fetch only the limited number of Gists.
 
 	Input
 
-		integar
-			``integar`` is **required** as an argument which will limit the number of Gists to be listed.
+		integer
+			``integer`` is **required** as an argument which will limit the number of Gists to be listed.
 
 .. code-block:: python
 
 	GHgist.search('_USERNAME').list(2)
-	
+
 Fetching the contents of a Gist using GistName ``search('_USERNAME').content(params)``
 --------------------------------------------------------------------------------------
 
@@ -38,7 +38,7 @@ Fetch the contents of a Gist by name (GistName).
 .. code-block:: python
 
 	GHgist.search('_USERNAME').content(name='_GISTNAME')
-	
+
 Fetching the contents of any Gist using GistID ``search('').content(id='_GISTID')``
 -----------------------------------------------------------------------------------
 
@@ -60,15 +60,15 @@ Fetch Gist's name by provoding it's ID i.e. GistID.
 Fetch Gist-Link, Clone-Link and Embed-Script-Link of searched gist ``search('_USERNAME/EMPTY').links(id/name)``
 ------------------------------------------------------------------------------------------------------------------------------
 
-It is very very useful and solves the dual purpose. Providing the username and a Gistname of that user not only provides the above mentioned Links but also let 'one' know about the GistID of that Gist. 
+It is very very useful and solves the dual purpose. Providing the username and a Gistname of that user not only provides the above mentioned Links but also let 'one' know about the GistID of that Gist.
 
 Moreover, this criteria can also be applied in finding 'one\'s' own Gist's GistID by providing Gistname.
 
 .. note::
 
 	Input
 
-		``name/id`` - 
+		``name/id`` -
 					  if providing GistdID, Github-Username should be blank like 	search(''),links(id='_GISTID')
 					  if providing GistName, Github-Username is required like search('Github-User').links(name='THATUSERSGISTNAME')
 

setup.py

@@ -10,17 +10,17 @@
 
 setup(
     name = 'simplegist',
-    packages = ['simplegist'], 
-    version = '0.3.2',
+    packages = ['simplegist'],
+    version = '1.0.0',
     install_requires=required,
     description = 'Python wrapper for Gist ',
     long_description=open('README.rst').read(),
     author = 'Varun Malhotra',
     author_email = '[email protected]',
-    url = 'https://github.com/softvar/GistApi-Wrapper-python', 
-    download_url = 'https://github.com/softvar/GistApi-Wrapper-python/tarball/0.3.2',
+    url = 'https://github.com/softvar/GistApi-Wrapper-python',
+    download_url = 'https://github.com/softvar/GistApi-Wrapper-python/tarball/1.0.0',
     keywords = ['gist', 'github', 'API'],
-    license = 'MIT', 
+    license = 'MIT',
     classifiers = (
         "Programming Language :: Python",
         "Programming Language :: Python :: 2.5",