Metadata-Version: 2.0
Name: yourls
Version: 1.2.2
Summary: Python client for YOURLS.
Home-page: https://github.com/razerm/yourls-python
Author: Frazer McLean
Author-email: frazer@frazermclean.co.uk
License: MIT
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Requires-Dist: click
Requires-Dist: requests
Requires-Dist: represent (>=1.4.0)
Requires-Dist: six
Requires-Dist: logbook (>=0.10.0)
Provides-Extra: dev
Requires-Dist: tox; extra == 'dev'
Requires-Dist: pytest (>=2.7.3); extra == 'dev'
Requires-Dist: sphinx-rtd-theme; extra == 'dev'
Requires-Dist: shovel; extra == 'dev'
Requires-Dist: responses; extra == 'dev'
Requires-Dist: pep8-naming; extra == 'dev'
Requires-Dist: flake8; extra == 'dev'
Requires-Dist: pyenchant; extra == 'dev'
Requires-Dist: flake8-coding; extra == 'dev'
Requires-Dist: sphinxcontrib-spelling; extra == 'dev'
Requires-Dist: sphinx; extra == 'dev'
Requires-Dist: coverage; extra == 'dev'
Requires-Dist: watchdog; extra == 'dev'
Requires-Dist: plumbum; extra == 'dev'
Requires-Dist: doc8; extra == 'dev'
Requires-Dist: flake8-future-import; extra == 'dev'
Provides-Extra: dev
Requires-Dist: mock; python_version<"3.3" and extra == 'dev'

yourls
------

|PyPI Version| |Documentation| |Travis| |Coverage| |Python Version| |MIT License|

Installation
~~~~~~~~~~~~

.. code:: bash

    $ pip install yourls

Example
~~~~~~~

.. code:: python

   >>> from yourls import YOURLSClient

   >>> yourls = YOURLSClient('http://example.com/yourls-api.php', signature='6f344c2a8p')
   >>> yourls.shorten('http://google.com')
   ShortenedURL(
       shorturl='http://example.com/abcde',
       url='http://google.com',
       title='Google',
       date=datetime.datetime(2015, 10, 31, 14, 31, 4),
       ip='203.0.113.0',
       clicks=0,
       keyword='abcde')

Documentation
~~~~~~~~~~~~~

For in-depth information, `visit the
documentation <http://yourls-python.readthedocs.org/en/latest/>`__!

.. |Travis| image:: http://img.shields.io/travis/RazerM/yourls-python/master.svg?style=flat-square&label=travis
   :target: https://travis-ci.org/RazerM/yourls-python
.. |PyPI Version| image:: http://img.shields.io/pypi/v/yourls.svg?style=flat-square
   :target: https://pypi.python.org/pypi/yourls/
.. |Python Version| image:: https://img.shields.io/badge/python-2.7%2C%203-brightgreen.svg?style=flat-square
   :target: https://www.python.org/downloads/
.. |MIT License| image:: http://img.shields.io/badge/license-MIT-blue.svg?style=flat-square
   :target: https://raw.githubusercontent.com/RazerM/yourls-python/master/LICENSE
.. |Coverage| image:: https://img.shields.io/codecov/c/github/RazerM/yourls-python/master.svg?style=flat-square
   :target: https://codecov.io/github/RazerM/yourls-python?branch=master
.. |Documentation| image:: https://img.shields.io/badge/docs-latest-brightgreen.svg?style=flat-square
   :target: http://yourls-python.readthedocs.org/en/latest/


