umami-analytics 0.1.0__py3-none-any.whl

umami/__init__.py

@@ -0,0 +1,210 @@
+"""umami - Umami Analytics Client for Python"""
+
+__version__ = '0.1.0'
+__author__ = 'Michael Kennedy <michael@talkpython.fm>'
+__all__ = []
+
+import sys
+from typing import Optional
+
+import httpx
+
+from umami import models, urls  # noqa: F401
+
+url_base: Optional[str] = None
+auth_token: Optional[str] = None
+event_user_agent = 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:121.0) Gecko/20100101 Firefox/121.0'
+user_agent = (f'Umami-Client v{__version__} / '
+              f'Python {sys.version_info.major}.{sys.version_info.minor}.{sys.version_info.micro}')
+
+
+def set_url_base(url: str):
+    if not url or not url.strip():
+        raise Exception("URL must not be empty")
+
+    global url_base
+    url_base = url.strip()
+
+
+async def login_async(username: str, password: str) -> models.LoginResponse:
+    global auth_token
+    validate_state(url=True)
+    validate_login(username, password)
+
+    url = f'{url_base}{urls.login}'
+    headers = {'User-Agent': user_agent}
+    api_data = {
+        "username": username,
+        "password": password,
+    }
+    async with httpx.AsyncClient() as client:
+        resp = await client.post(url, data=api_data, headers=headers)
+        resp.raise_for_status()
+
+    model = models.LoginResponse(**resp.json())
+    auth_token = model.token
+    return model
+
+
+def login(username: str, password: str) -> models.LoginResponse:
+    global auth_token
+
+    validate_state(url=True)
+    validate_login(username, password)
+
+    url = f'{url_base}{urls.login}'
+    headers = {'User-Agent': user_agent}
+    api_data = {
+        "username": username,
+        "password": password,
+    }
+    resp = httpx.post(url, data=api_data, headers=headers)
+    resp.raise_for_status()
+
+    model = models.LoginResponse(**resp.json())
+    auth_token = model.token
+    return model
+
+
+async def websites_async() -> list[models.Website]:
+    global auth_token
+    validate_state(url=True, user=True)
+
+    url = f'{url_base}{urls.websites}'
+    headers = {
+        'User-Agent': user_agent,
+        'Authorization': f'Bearer {auth_token}',
+    }
+    async with httpx.AsyncClient() as client:
+        resp = await client.get(url, headers=headers)
+        resp.raise_for_status()
+
+    model = models.WebsitesResponse(**resp.json())
+    return model.websites
+
+
+def websites() -> list[models.Website]:
+    global auth_token
+    validate_state(url=True, user=True)
+
+    url = f'{url_base}{urls.websites}'
+    headers = {
+        'User-Agent': user_agent,
+        'Authorization': f'Bearer {auth_token}',
+    }
+    resp = httpx.get(url, headers=headers)
+    resp.raise_for_status()
+
+    data = resp.json()
+    model = models.WebsitesResponse(**data)
+    return model.websites
+
+
+async def new_event_async(website_id: str, event_name: str, title: str, hostname: str, url: str = '/',
+                          custom_data=None, referrer: Optional[str] = None, language: str = 'en-US',
+                          screen: str = "1920x1080", ) -> str:
+    custom_data = custom_data or {}
+
+    payload = models.EventPayload(
+        website=website_id, name=event_name, title=title, hostname=hostname, url=url,
+        screen=screen, referrer=referrer, language=language, data=custom_data)
+
+    url = f'{url_base}{urls.events}'
+    headers = {
+        'User-Agent': event_user_agent,
+        'Authorization': f'Bearer {auth_token}',
+    }
+    event_data = {
+        'payload': payload,
+        'type': 'event'
+    }
+
+    async with httpx.AsyncClient() as client:
+        resp = await client.post(url, data=event_data, headers=headers)
+        resp.raise_for_status()
+
+    return resp.text
+
+
+async def new_event_async(website_id: str, event_name: str, title: str, hostname: str, url: str = '/',
+                          custom_data=None, referrer: Optional[str] = None, language: str = 'en-US',
+                          screen: str = "1920x1080") -> str:
+    custom_data = custom_data or {}
+
+    url = f'{url_base}{urls.events}'
+    headers = {
+        'User-Agent': event_user_agent,
+        'Authorization': f'Bearer {auth_token}',
+    }
+
+    payload = {
+        "hostname": hostname,
+        "language": language,
+        "referrer": referrer,
+        "screen": screen,
+        "title": title,
+        "url": url,
+        "website": website_id,
+        "name": event_name,
+        "data": custom_data
+    }
+
+    event_data = {
+        'payload': payload,
+        'type': 'event'
+    }
+
+    async with httpx.AsyncClient() as client:
+        resp = await client.post(url, json=event_data, headers=headers)
+        resp.raise_for_status()
+
+    return resp.text
+
+
+def new_event(website_id: str, event_name: str, title: str, hostname: str, url: str = '/',
+              custom_data=None, referrer: Optional[str] = None, language: str = 'en-US',
+              screen: str = "1920x1080") -> str:
+    custom_data = custom_data or {}
+
+    url = f'{url_base}{urls.events}'
+    headers = {
+        'User-Agent': event_user_agent,
+        'Authorization': f'Bearer {auth_token}',
+    }
+
+    payload = {
+        "hostname": hostname,
+        "language": language,
+        "referrer": referrer,
+        "screen": screen,
+        "title": title,
+        "url": url,
+        "website": website_id,
+        "name": event_name,
+        "data": custom_data
+    }
+
+    event_data = {
+        'payload': payload,
+        'type': 'event'
+    }
+
+    resp = httpx.post(url, json=event_data, headers=headers)
+    resp.raise_for_status()
+
+    return resp.text
+
+
+def validate_login(email, password):
+    if not email:
+        raise Exception("Email cannot be empty")
+    if not password:
+        raise Exception("Password cannot be empty")
+
+
+def validate_state(url=False, user=False):
+    if url and not url_base:
+        raise Exception("URL Base must be set to proceed.")
+
+    if user and not auth_token:
+        raise Exception("You must login before proceeding.")

umami/models/__init__.py

@@ -0,0 +1,63 @@
+import typing
+
+import pydantic
+
+
+class User(pydantic.BaseModel):
+    id: str
+    username: str
+    role: str
+    createdAt: str
+    isAdmin: bool
+
+
+class LoginResponse(pydantic.BaseModel):
+    token: str
+    user: User
+
+
+class TokenVerification(pydantic.BaseModel):
+    id: str
+    username: str
+    role: str
+    createdAt: str
+    isAdmin: bool
+
+
+class WebsiteTeam(pydantic.BaseModel):
+    name: str
+
+
+class WebsiteUser(pydantic.BaseModel):
+    username: str
+    id: str
+
+
+class TeamSiteDetails(pydantic.BaseModel):
+    id: str
+    teamId: str
+    websiteId: str
+    createdAt: str
+    team: WebsiteTeam
+
+
+class Website(pydantic.BaseModel):
+    id: str
+    name: typing.Optional[str] = None
+    domain: str
+    shareId: typing.Any
+    resetAt: typing.Any
+    userId: str
+    createdAt: str
+    updatedAt: str
+    deletedAt: typing.Any
+    teamWebsite: list[TeamSiteDetails]
+    user: WebsiteUser
+
+
+class WebsitesResponse(pydantic.BaseModel):
+    websites: list[Website] = pydantic.Field(alias="data")
+    count: int
+    page: int
+    pageSize: int
+    orderBy: typing.Optional[str] = None

umami/urls.py

@@ -0,0 +1,3 @@
+login = '/api/auth/login'
+websites = '/api/websites'
+events = '/api/send'

umami_analytics-0.1.0.dist-info/METADATA

@@ -0,0 +1,41 @@
+Metadata-Version: 2.1
+Name: umami-analytics
+Version: 0.1.0
+Summary: Umami Analytics Client for Python
+Project-URL: Homepage, https://github.com/mikeckennedy/umami-python
+Project-URL: Tracker, https://github.com/mikeckennedy/umami-python/issues
+Project-URL: Source, https://github.com/mikeckennedy/umami-python
+Author-email: Michael Kennedy <michael@talkpython.fm>
+License-Expression: MIT
+License-File: LICENSE
+Keywords: analtyics,umami,website
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.8
+Requires-Dist: httpx
+Requires-Dist: pydantic
+Description-Content-Type: text/markdown
+
+### Umami Analytics Client for Python
+
+## Usage
+
+## Installation
+
+### Requirements
+
+
+## Compatibility
+
+## Licence
+
+## Authors
+
+`umami` was written by **Michael Kennedy** [michael@talkpython.fm](mailto:michael@talkpython.fm).

umami_analytics-0.1.0.dist-info/RECORD

@@ -0,0 +1,8 @@
+umami/__init__.py,sha256=7F2n8roh4C7_4lsgytanrG0WwQnHhx67QWzXanQo3g4,5840
+umami/urls.py,sha256=6TICLKa0gRuYIyNNGqzAzPeq-KNKtBP5Hi5YNl1MhaM,74
+umami/__impl/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+umami/models/__init__.py,sha256=jc4WU84fxgxVJpB-NpZtDLeqqrgWXDRpO7-Dgy4LWZw,1091
+umami_analytics-0.1.0.dist-info/METADATA,sha256=ASRXdVbwwmf_pxyVCGzWDpqmechVjXUTnDHlWFyMVlw,1221
+umami_analytics-0.1.0.dist-info/WHEEL,sha256=mRYSEL3Ih6g5a_CVMIcwiF__0Ae4_gLYh01YFNwiq1k,87
+umami_analytics-0.1.0.dist-info/licenses/LICENSE,sha256=12NN0UxiyDHVbhIG43LgZQLLxijQUO0Uj8TcT0RkR2A,1081
+umami_analytics-0.1.0.dist-info/RECORD,,

umami_analytics-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.21.0
+Root-Is-Purelib: true
+Tag: py3-none-any

umami_analytics-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Michael Kennedy
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.