Metadata-Version: 2.4
Name: gdshortener
Version: 1.0.1
Summary: A module that provides access to .gd URL Shortener
Home-page: https://github.com/torre76/gd_shortener
Download-URL: https://github.com/torre76/gd_shortener/tarball/1.0.1
Author: Gian Luca Dalla Torre
Author-email: gianluca@gestionaleauto.com
License: LGPL
Keywords: url shortener gd
Classifier: Development Status :: 5 - Production/Stable
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: License :: OSI Approved :: GNU Library or Lesser General Public License (LGPL)
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Requires-Dist: requests>=2.21.0
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: download-url
Dynamic: home-page
Dynamic: keywords
Dynamic: license
Dynamic: requires-dist
Dynamic: summary

GD Shortener
=============

Python Module for `is.gd - v.gd <http://is.gd/apishorteningreference.php>`_ URL Shortener.

.. image:: https://circleci.com/gh/torre76/gd_shortener.svg?style=svg
    :target: https://circleci.com/gh/torre76/gd_shortener

What is this?
-------------

*GD Shortener* allow Python software to access `is.gd - v.gd <http://is.gd/apishorteningreference.php>`_ URL shortener service.

Using this module you could shorten an URL to a small one like *Twitter* does for its link.

This service is provided by `is.gd - v.gd <http://is.gd/apishorteningreference.php>`_ and, thru the classes in this module, you could view stats on shortened URLs and obtain reverse lookup on URLs. 

Install
-------

To install *GD Shortener*, run the following command::

    pip install gdshortener
	
Usage
-----


After install, to use *GD Shortener* is sufficient to import the package, choose the implementing class `ISGDShortener` or `VGDShortener` (it maps to is.gd or v.gd) and use the following code:

.. code-block:: python 
	 
	import gdshortener
	
	s = gdshortener.ISGDShortener()
	print s.shorten('http://www.google.com')
	
If you want statistic usage on a URL use:

.. code-block:: python
	
	print s.shorten(url = 'http://www.google.com', log_stat = True)
	
If you want a custom URL use:

.. code-block:: python
	
	print s.shorten(url = 'http://www.google.com', custom_url = 'Pippus')

If you want to ignore SSL certificate (for older version of OpenSSL):

.. code-block:: python

	print s.shorten(url = 'https://expired.badssl.com', verify_ssl = False)

If you have an already shortened URL and want a reverse lookup:

.. code-block:: python
	
	print s.lookup('http://is.gd/Pippus')
	
License
-------

*GD Shortener* is licensed under LGPL. See LICENSE.txt for details.
