{ "info": { "author": "Kylie Auld", "author_email": "kylie.a@protonmail.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 2 - Pre-Alpha", "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Natural Language :: English", "Programming Language :: Python :: 2", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.4", "Programming Language :: Python :: 3.5", "Programming Language :: Python :: 3.6", "Programming Language :: Python :: 3.7" ], "description": "====\npolr\n====\n\n\n.. image:: https://img.shields.io/pypi/v/polr.svg\n :target: https://pypi.python.org/pypi/polr-py\n\n.. image:: https://img.shields.io/travis/kylie-a/polr.svg\n :target: https://travis-ci.org/kylie-a/polr-py\n\n.. image:: https://readthedocs.org/projects/polr/badge/?version=latest\n :target: https://polr.readthedocs.io/en/latest/?badge=latest\n :alt: Documentation Status\n\n\n.. image:: https://pyup.io/repos/github/kylie-a/polr/shield.svg\n :target: https://pyup.io/repos/github/kylie-a/polr-py/\n :alt: Updates\n\n\n\nPython CLI for the Polr link shortener\n\n\n* Free software: MIT license\n* Documentation: https://polr.readthedocs.io.\n\n\nFeatures\n--------\n\n* TODO\n\nCLI Usage\n=========\n\n.. code-block::\n\n polr [OPTIONS] COMMAND [ARGS]...\n\nCommands for using the Go link shortening service.\n\nOptions:\n\n- ``--help``: Show this message and exit.\n\nCommands:\n\n- ``exists``: Check to see if a link with the given ending already exists.\n- ``shorten``: Shorten a link with the option to give it a custom ending.\n\n\n``shorten``\n-----------\n\nUsage:\n\n polr shorten [OPTIONS] URL\n\nShorten a link with the option to give it a custom ending. Checks to see\nif a link with the given ending exists. Can be configured to fail if it\nalready exists with ``[-f|--fail]``.\n\n.. code-block::\n\n polr shorten URL [(-e|--ending=)ending] [(-f|--fail)]`\n\nExamples:\n\n.. code-block::\n\n # Use default ending\n $ polr shorten https://example.com\n http://polr.example.com/ad14gfwe\n\n # Use custom ending, if ending already exists don't return error, return link with that ending.\n polr shorten https://example.com -e my-custom-ending\n http://polr.example.com/my-custom-ending\n\n # Use custom ending, return error if it already exists.\n polr shorten https://example.com -e my-custom-ending -f\n ERROR: link with ending my-custom-ending already exists\n echo \"$?\"\n 1\n\nOptions:\n\n- ``-e, --ending TEXT`` A custom ending for the shortened link.\n- ``-f, --fail`` Return an error if a link with the desired custom ending already exists\n- ``--help`` Show this message and exit.\n\n#### `exists`\n\nUsage:\n\n polr exists [OPTIONS] ENDING\n\nCheck to see if a link with the given ending already exists. Exits with status code 1 if it exists\n\nExamples:\n\n.. code-block:: console\n\n # Doesn't exist\n $ polr exists my-new-ending\n False\n $ echo \"$?\"\n 0\n\n # Exists\n $ polr exists my-existing-ending\n True\n $ echo \"$?\"\n 1\n\nOptions:\n\n- ``--help``: Show this message and exit.\n\n\nCredits\n-------\n\nThis package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.\n\n.. _Cookiecutter: https://github.com/audreyr/cookiecutter\n.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage\n\n\n=======\nHistory\n=======\n\n0.1.0 (2018-12-12)\n------------------\n\n* First release on PyPI.", "description_content_type": "", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/kylie-a/polr-py", "keywords": "polr", "license": "MIT license", "maintainer": "", "maintainer_email": "", "name": "polr-py", "package_url": "https://pypi.org/project/polr-py/", "platform": "", "project_url": "https://pypi.org/project/polr-py/", "project_urls": { "Homepage": "https://github.com/kylie-a/polr-py" }, "release_url": "https://pypi.org/project/polr-py/0.3.3/", "requires_dist": null, "requires_python": "", "summary": "Python CLI for the Polr link shortener", "version": "0.3.3" }, "last_serial": 4618157, "releases": { "0.3.3": [ { "comment_text": "", "digests": { "md5": "12a23c8773229635ada37f0c552c7366", "sha256": "499fa439559df9bb295631373b876e04a9cb4fd8d667feceb96934bb0ec9de49" }, "downloads": -1, "filename": "polr_py-0.3.3.tar.gz", "has_sig": false, "md5_digest": "12a23c8773229635ada37f0c552c7366", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 12185, "upload_time": "2018-12-19T20:44:13", "url": "https://files.pythonhosted.org/packages/ac/d8/6ee145c2555578bdcd1d99b7e18f35f2208fe9868e7fd8745d4c41f6526a/polr_py-0.3.3.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "12a23c8773229635ada37f0c552c7366", "sha256": "499fa439559df9bb295631373b876e04a9cb4fd8d667feceb96934bb0ec9de49" }, "downloads": -1, "filename": "polr_py-0.3.3.tar.gz", "has_sig": false, "md5_digest": "12a23c8773229635ada37f0c552c7366", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 12185, "upload_time": "2018-12-19T20:44:13", "url": "https://files.pythonhosted.org/packages/ac/d8/6ee145c2555578bdcd1d99b7e18f35f2208fe9868e7fd8745d4c41f6526a/polr_py-0.3.3.tar.gz" } ] }