skip to navigation
skip to content

Not Logged In

pyshorteners 0.3

A simple URL shortening Python Lib, implementing the most famous shorteners.

============
Pyshorteners
============

.. image:: https://api.travis-ci.org/ellisonleao/pyshorteners.png
:alt: Build Status
:target: https://travis-ci.org/ellisonleao/pyshorteners

.. image:: https://pypip.in/v/pyshorteners/badge.png
:target: https://crate.io/packages/pyshorteners/
:alt: Latest PyPI version

.. image:: https://pypip.in/d/pyshorteners/badge.png
:target: https://crate.io/packages/pyshorteners/
:alt: Number of PyPI downloads

.. image:: https://coveralls.io/repos/ellisonleao/pyshorteners/badge.png?branch=master
:target: https://coveralls.io/r/ellisonleao/pyshorteners?branch=master
:alt: Coverage

Description
===========

A simple URL shortening Python Lib, implementing the most famous
shorteners.


Installing
==========

You can install pythorteners by pip or cloning/forking the repository and just typing

Installing via pip

::

pip install pyshorteners


Installing with the cloned/downloaded code

::

python setup.py install

Testing
-------

Use tox to test with all environments needed by just typing `tox` on command line


Usage
=====

Create a Shortener instance passing the engine as an argument. Google
Shortener is the default engine if no engine param is passed.

Goo.gl Shortener
---------------

No login or api key needed on kwargs

.. code-block:: python

from pyshorteners.shorteners import Shortener

url = 'http://www.google.com'
shortener = Shortener('GoogleShortener')
print "My short url is {}".format(shortener.short(url))

# expanding
url = 'http://goo.gl/SsadY'
print "My long url is {}".format(shortener.expand(url))

Bit.ly Shortener
----------------

API Key and login configs needed on kwargs

.. code-block:: python

from pyshorteners.shorteners import Shortener

# For Bit.ly you HAVE to provide the login and api key
login = 'MY_LOGIN'
api_key = 'MY_API_KEY'

url = 'http://www.google.com'
shortener = Shortener('BitlyShortener', bitly_login=login, bitly_api_key=api_key)
print "My short url is {}".format(shortener.short(url))

# expanding
url = 'http://bit.ly/AvGsb'
print "My long url is {}".format(shortener.expand(url))

TinyURL.com Shortener
-----------------

No login or api key needed

.. code-block:: python

from pyshorteners.shorteners import Shortener

url = 'http://www.google.com'
shortener = Shortener('TinyurlShortener')
print "My short url is {}".format(shortener.short(url))

# expanding
url = 'http://tinyurl.com/ycus76'
print "My long url is {}".format(shortener.expand(url))

Adf.ly Shortener
-----------------

uid and api key needed, banner type optional (int or banner)
No expanding for this shortener

.. code-block:: python

from pyshorteners.shorteners import Shortener

url = 'http://www.google.com'
shortener = Shortener('AdflyShortener')
print "My short url is {}".format(shortener.short(url, uid=UID,
api_key=API_KEY, type='int'))



Is.gd Shortener
-----------------

No login or api key needed

.. code-block:: python

from pyshorteners.shorteners import Shortener

url = 'http://www.google.com'
shortener = Shortener('IsgdShortener')
print "My short url is {}".format(shortener.short(url))

# expanding
url = 'http://is.gd/SsaC'
print "My long url is {}".format(shortener.expand(url))


Senta.la Shortener
-----------------

No login or api key needed

.. code-block:: python

from pyshorteners.shorteners import Shortener

url = 'http://www.google.com'
shortener = Shortener('SentalaShortener')
print "My short url is {}".format(shortener.short(url))

# expanding
url = 'http://senta.la/urubu'
print "My long url is {}".format(shortener.expand(url))


Generic expander
----------------

No login or api key needed.
Generic expander service, allows to expand url's generically no matter what source shortening service was used
It works with regular url's returning the same url.
Trying to shorten an url throws an exception

.. code-block:: python

from pyshorteners.shorteners import Shortener

# Another service is used to shorten to simulate an already shortened url
url = 'http://www.google.com'
shortener = Shortener('GoogleShortener')
shortened_url = shortener.short(url)
print "My short url is {}".format(shortened_url)

expander = Shortener('GenericExpander')

# expanding
print "My long url is {} using generic expander".format(expander.expand(shortened_url))



QR Code
=======

You can have the QR Code for your url by calling the `qr_code` method after shorteing your url.  
File Type Py Version Uploaded on Size
pyshorteners-0.3.tar.gz (md5) Source 2014-05-13 5KB
  • Downloads (All Versions):
  • 53 downloads in the last day
  • 211 downloads in the last week
  • 778 downloads in the last month