umami python

Umami Analytics Client for Python

Klien untuk Privacy-Preserving, platform UMAMI Source Open Source berdasarkan httpx dan pydantic .

umami-analytics dimaksudkan untuk menambahkan data khusus ke instance UMAMI Anda (self-hosting atau SaaS). Banyak acara UMAMI dapat disediakan langsung dari HTML melalui atribut data-* mereka. Namun, beberapa tidak bisa. Misalnya, jika Anda memiliki acara yang dipicu di aplikasi Anda tetapi tidak memiliki tindakan HTML yang jelas, Anda dapat menambahkan acara khusus. Ini akan muncul di bagian bawah halaman Umami Analtytics Anda untuk situs web.

Salah satu contohnya adalah acara pembelian-kursus yang terjadi jauh di dalam kode Python daripada di HTML di Talk Python Training. Inilah yang terlihat seperti bagian acara kami untuk hari akhir pekan yang khas (waktu Pasifik AS):

Berfokus pada apa yang Anda butuhkan, bukan apa yang ditawarkan

API UMAMI sangat luas dan banyak yang dimaksudkan agar kode frontend mereka dapat berfungsi. Anda mungkin tidak menginginkan atau membutuhkannya. umami-analytics hanya mencakup subset yang dibutuhkan sebagian besar pengembang untuk tindakan SaaS umum seperti menambahkan acara khusus. Yang mengatakan, PRS adalah weclome.

Fitur Inti

• ➕ Tambahkan acara khusus ke dasbor Umami Analytics Anda.
• Sebutkan semua situs web dengan detail yang telah Anda daftarkan di Umami.
• ? Model pemrograman sinkronisasi dan async .
• ⚒️ Data terstruktur dengan model Pydantic untuk respons API.
• ? ‍ Masuk / otentikasi untuk instance Umami yang diselenggarakan sendiri atau SaaS yang di-host.
• ? Tetapkan situs web default untuk API yang disederhanakan ke depan.

Lihat contoh penggunaan di bawah ini untuk API Python di sekitar fitur -fitur ini.

Async atau Sync API? Anda memilih

? Async didukung tetapi tidak diperlukan untuk kode Python Anda. Untuk fungsi yang mengakses jaringan, ada varian func() dan func_async() yang berfungsi dengan async dan await Python.

Instalasi

pip install umami-analytics

Penggunaan

 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 ()

Daftar kode ini adalah kode psuedo kesetiaan tinggi yang sangat sangat tinggi. Jika Anda menginginkan contoh yang benar -benar dapat dieksekusi, lihat contoh klien di repo.

Ingin berkontribusi?

Lihat dokumentasi API untuk titik akhir yang tersisa yang akan ditambahkan. PR dipersilakan. Tapi tolong buka masalah terlebih dahulu untuk melihat apakah fitur yang diusulkan cocok dengan arah perpustakaan ini.

Menikmati.