https://github.com/razerm/yourls-python

Python YOURLS client
https://github.com/razerm/yourls-python

Last synced: 3 months ago
JSON representation

Python YOURLS client

• Host: GitHub
• URL: https://github.com/razerm/yourls-python
• Owner: RazerM
• License: mit
• Created: 2015-11-01T00:28:22.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2020-09-30T18:45:52.000Z (over 4 years ago)
• Last Synced: 2024-04-21T22:25:25.132Z (9 months ago)
• Language: Python
• Size: 50.8 KB
• Stars: 10
• Watchers: 3
• Forks: 8
• Open Issues: 6
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG.md
  • License: LICENSE.txt

Awesome Lists containing this project

• awesome - yourls-python - `pip install yourls` for Python 2 or 3 (Integrations / 3rd party Integrations and Frameworks)

README

        
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 `__!

.. |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/