{ "info": { "author": "David Southgate", "author_email": "d@davidsouthgate.co.uk", "bugtrack_url": null, "classifiers": [ "License :: OSI Approved :: MIT License", "Operating System :: OS Independent", "Programming Language :: Python :: 3" ], "description": "# shlink-py\nPython module for API communication with [Shlink](https://shlink.io)\n\n## Installation\nTo install simply use pip:\n\n```bash\npip install shlink\n```\n\n## Usage\nThe package is used by creating a new instance of an Shlink object. API calls can then be made using methods on this object.\n\nAn example of all of the calls available is shown in the below example:\n\n```python\nimport json\nimport sys\nfrom datetime import datetime\nfrom shlink import Shlink\nfrom shlink.data import Error\n\nshlink = Shlink(\n url=\"https://example.com/\",\n api_key=\"000000000-0000-0000-0000-000000000000\"\n)\n\n# LIST_SHORT_URLS\nresult = shlink.list_short_urls()\nprint(json.dumps(result.to_dict()))\nif isinstance(result, Error):\n sys.exit(1)\n\n# ADD_SHORT_URL\nresult = shlink.add_short_url(\n long_url=\"http://example.com/\",\n tags=[\n \"example\"\n ],\n valid_since=datetime(2019, 3, 14),\n valid_until=datetime(2019, 3, 20),\n custom_slug=\"example\",\n max_visits=100,\n find_if_exists=False\n)\nprint(json.dumps(result.to_dict()))\nif isinstance(result, Error):\n sys.exit(2)\n\n# GET_SHORT_URL\nresult = shlink.get_short_url(\"example\")\nprint(json.dumps(result.to_dict()))\nif isinstance(result, Error):\n sys.exit(3)\n```\n\n## Development\nTo run this project in a development environment `pipenv` is recommended.\n\nE.g.\n```bash\npipenv run python example.py\n```\n\n\n", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://bitbucket.org/davidksouthgate/shlink-py/", "keywords": "", "license": "", "maintainer": "", "maintainer_email": "", "name": "shlink", "package_url": "https://pypi.org/project/shlink/", "platform": "", "project_url": "https://pypi.org/project/shlink/", "project_urls": { "Homepage": "https://bitbucket.org/davidksouthgate/shlink-py/" }, "release_url": "https://pypi.org/project/shlink/0.1.0/", "requires_dist": null, "requires_python": "", "summary": "Python package for API communication with Shlink", "version": "0.1.0" }, "last_serial": 4944662, "releases": { "0.0.4": [ { "comment_text": "", "digests": { "md5": "d2b2d9f8d967cc1385e65cdbdeb3e748", "sha256": "7cfe2940c0a18080497b0f82b0203946413f7290d36770ae1bebdc3d47a40e84" }, "downloads": -1, "filename": "shlink-0.0.4-py3-none-any.whl", "has_sig": false, "md5_digest": "d2b2d9f8d967cc1385e65cdbdeb3e748", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 6879, "upload_time": "2019-03-15T14:04:11", "url": "https://files.pythonhosted.org/packages/66/1c/c9e10d50bab282119f2dcf97bf45cde1993c2d93eb59df1e5fe7510d807b/shlink-0.0.4-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "e3c54f435635b85350dcee82c213edb9", "sha256": "1b7f23ed434a7a2680348294186c211eadb28b12de79eefdbb226cac9fba3aba" }, "downloads": -1, "filename": "shlink-0.0.4.tar.gz", "has_sig": false, "md5_digest": "e3c54f435635b85350dcee82c213edb9", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3524, "upload_time": "2019-03-15T14:04:13", "url": "https://files.pythonhosted.org/packages/fe/2a/4a505dfa699ea521533868046d903647d93f0cd99ca2fb8426cfd79d93de/shlink-0.0.4.tar.gz" } ], "0.1.0": [ { "comment_text": "", "digests": { "md5": "100cb353ee040e3bf23e456842157664", "sha256": "5a70f0b375aad713f2b9275cd2fdf2faf93a29021edd15f391546de8cff31031" }, "downloads": -1, "filename": "shlink-0.1.0-py3-none-any.whl", "has_sig": false, "md5_digest": "100cb353ee040e3bf23e456842157664", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 7640, "upload_time": "2019-03-15T15:08:59", "url": "https://files.pythonhosted.org/packages/57/13/3fd37480b6eb95d0160f22954a5f08154ae8d858d2feed05c0149a2ce8fa/shlink-0.1.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "bc22876293f5b80328b645a203f0fb83", "sha256": "445b3a53a00bc99f45ed7e96220f4d0b22cefdfe21be8b6c0e4bdf64204aaf6c" }, "downloads": -1, "filename": "shlink-0.1.0.tar.gz", "has_sig": false, "md5_digest": "bc22876293f5b80328b645a203f0fb83", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4356, "upload_time": "2019-03-15T15:09:00", "url": "https://files.pythonhosted.org/packages/bd/aa/f2948700bf52aabfc8eeff94e8fab6cd30eb2839226d77df47f33346a5bd/shlink-0.1.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "100cb353ee040e3bf23e456842157664", "sha256": "5a70f0b375aad713f2b9275cd2fdf2faf93a29021edd15f391546de8cff31031" }, "downloads": -1, "filename": "shlink-0.1.0-py3-none-any.whl", "has_sig": false, "md5_digest": "100cb353ee040e3bf23e456842157664", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 7640, "upload_time": "2019-03-15T15:08:59", "url": "https://files.pythonhosted.org/packages/57/13/3fd37480b6eb95d0160f22954a5f08154ae8d858d2feed05c0149a2ce8fa/shlink-0.1.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "bc22876293f5b80328b645a203f0fb83", "sha256": "445b3a53a00bc99f45ed7e96220f4d0b22cefdfe21be8b6c0e4bdf64204aaf6c" }, "downloads": -1, "filename": "shlink-0.1.0.tar.gz", "has_sig": false, "md5_digest": "bc22876293f5b80328b645a203f0fb83", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4356, "upload_time": "2019-03-15T15:09:00", "url": "https://files.pythonhosted.org/packages/bd/aa/f2948700bf52aabfc8eeff94e8fab6cd30eb2839226d77df47f33346a5bd/shlink-0.1.0.tar.gz" } ] }