用于与shlink进行api通信的python包
shlink的Python项目详细描述
shlink py
用于与Shlink通信的api的python模块
安装
要安装,只需使用pip:
pip install shlink
用法
创建shlink对象的新实例时使用该包。然后可以使用此对象上的方法进行API调用。
下面的示例显示了所有可用呼叫的示例:
importjsonimportsysfromdatetimeimportdatetimefromshlinkimportShlinkfromshlink.dataimportErrorshlink=Shlink(url="https://example.com/",api_key="000000000-0000-0000-0000-000000000000")# LIST_SHORT_URLSresult=shlink.list_short_urls()print(json.dumps(result.to_dict()))ifisinstance(result,Error):sys.exit(1)# ADD_SHORT_URLresult=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()))ifisinstance(result,Error):sys.exit(2)# GET_SHORT_URLresult=shlink.get_short_url("example")print(json.dumps(result.to_dict()))ifisinstance(result,Error):sys.exit(3)
开发
若要在开发环境中运行此项目,建议使用pipenv
。
例如
pipenv run python example.py