Skip to main content

Python API for YOURLS.

Project description

PyPI Version Documentation Travis Coverage Python Version MIT License

Installation

$ pip install yourls

Example

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

Development

Project details


Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page