Metadata-Version: 2.1
Name: shlink
Version: 0.1.0
Summary: Python package for API communication with Shlink
Home-page: https://bitbucket.org/davidksouthgate/shlink-py/
Author: David Southgate
Author-email: d@davidsouthgate.co.uk
License: UNKNOWN
Description: # shlink-py
        Python module for API communication with [Shlink](https://shlink.io)
        
        ## Installation
        To install simply use pip:
        
        ```bash
        pip install shlink
        ```
        
        ## Usage
        The package is used by creating a new instance of an Shlink object. API calls can then be made using methods on this object.
        
        An example of all of the calls available is shown in the below example:
        
        ```python
        import json
        import sys
        from datetime import datetime
        from shlink import Shlink
        from shlink.data import Error
        
        shlink = Shlink(
            url="https://example.com/",
            api_key="000000000-0000-0000-0000-000000000000"
        )
        
        # LIST_SHORT_URLS
        result = shlink.list_short_urls()
        print(json.dumps(result.to_dict()))
        if isinstance(result, Error):
            sys.exit(1)
        
        # ADD_SHORT_URL
        result = shlink.add_short_url(
            long_url="http://example.com/",
            tags=[
                "example"
            ],
            valid_since=datetime(2019, 3, 14),
            valid_until=datetime(2019, 3, 20),
            custom_slug="example",
            max_visits=100,
            find_if_exists=False
        )
        print(json.dumps(result.to_dict()))
        if isinstance(result, Error):
            sys.exit(2)
        
        # GET_SHORT_URL
        result = shlink.get_short_url("example")
        print(json.dumps(result.to_dict()))
        if isinstance(result, Error):
            sys.exit(3)
        ```
        
        ## Development
        To run this project in a development environment `pipenv` is recommended.
        
        E.g.
        ```bash
        pipenv run python example.py
        ```
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
