umami python

Python的Umami Analytics客户端

基于httpx和pydantic的客户端，用于保护隐私的开源Umami Analytics平台。

umami-analytics旨在将自定义数据添加到您的Umami实例（自托管或SaaS）中。许多鲜味的事件可以通过其data-*属性直接从HTML提供。但是，有些不能。例如，如果您的应用程序中有一个事件，但没有明确的HTML操作，则可以添加自定义事件。这些将出现在您网站的Umami Analtytics页面的底部。

一个例子是一场采购事件，它发生在Python代码内部，而不是在Talk Python培训中的HTML中。这就是我们的活动部分在一个典型的周末（美国太平洋时间）的样子：

专注于您需要的东西，而不是提供的东西

Umami API是广泛的，其中大部分旨在其前端代码能够发挥作用。您可能不想要或需要。 umami-analytics仅涵盖大多数开发人员需要进行常见的SaaS动作（例如添加自定义事件）所需的子集。也就是说，PR是Weclome。

核心功能

• ➕向您的Umami Analytics仪表板添加自定义事件。
• 列出所有网站，其中包含您在Umami注册的详细信息。
• ？同步和异步编程模型。
• ⚒️结构化数据与Pydantic模型用于API响应。
• ？ ‍登录 /身份验证的自我托管或SaaS托管的乌马米实例。
• “为简化的API设置默认网站。

有关这些功能的Python API，请参见下面的用法示例。

异步或同步API？你选择

？支持异步，但不需要您的Python代码。对于访问网络的函数，有一个func()和func_async()变体，可与Python的async和await 。

安装

只需pip install umami-analytics

用法

 import umami

umami . set_url_base ( "https://umami.hostedbyyouorthem.com" )

# Auth is NOT required to send events, but is for other features.
login = umami . login ( username , password )

# Skip the need to pass the target website in subsequent calls.
umami . set_website_id ( 'cc726914-8e68-4d1a-4be0-af4ca8933456' )
umami . set_hostname ( 'somedomain.com' )

# List your websites
websites = umami . websites ()

# Create a new event in the events section of the dashboards.
event_resp = umami . new_event (
    website_id = 'a7cd-5d1a-2b33' , # Only send if overriding default above
    event_name = 'Umami-Test' ,
    title = 'Umami-Test' , # Defaults to event_name if omitted.
    hostname = 'somedomain.com' , # Only send if overriding default above.
    url = '/users/actions' ,
    custom_data = { 'client' : 'umami-tester-v1' },
    referrer = 'https://some_url' )

# Create a new page view in the pages section of the dashboards.
page_view_resp = umami . new_page_view (
    website_id = 'a7cd-5d1a-2b33' , # Only send if overriding default above
    page_title = 'Umami-Test' , # Defaults to event_name if omitted.
    hostname = 'somedomain.com' , # Only send if overriding default above.
    url = '/users/actions' ,
    referrer = 'https://some_url' )

# Call after logging in to make sure the auth token is still valid.
umami . verify_token ()

此代码列表是非常高的保真度PSUEDO代码。如果您想要一个实际可执行的示例，请参见回购中的示例客户端。

想贡献吗？

有关要添加的其余端点，请参见API文档。欢迎PR。但是请首先打开一个问题，以查看所提出的功能是否适合该库的方向。

享受。