Skip to content

web

sleap.gui.web

Module for web-related functionality.

Functions:

Name Description
get_analytics_data

Gather data to be transmitted to analytics backend.
ping_analytics

Ping analytics service with anonymous usage data.

get_analytics_data()

Gather data to be transmitted to analytics backend.

Source code in sleap/gui/web.py 
11
12
13
14
15
16
17
18
19
20
21
22
23
24
def get_analytics_data() -> Dict[str, Any]:
    """Gather data to be transmitted to analytics backend."""
    import os
    import sleap
    from pathlib import Path
    import platform

    return {
        "sleap_version": sleap.__version__,
        "python_version": platform.python_version(),
        "tf_version": "N/A",  # TensorFlow no longer bundled with GUI
        "conda_env": Path(os.environ.get("CONDA_PREFIX", "")).stem,
        "platform": platform.platform(),
    }

ping_analytics()

Ping analytics service with anonymous usage data.

Notes

This only gets called when the GUI starts and obeys user preferences for data collection.

See https://docs.sleap.ai/latest/help/#usage for more information.

Source code in sleap/gui/web.py 
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
def ping_analytics():
    """Ping analytics service with anonymous usage data.

    Notes:
        This only gets called when the GUI starts and obeys user preferences for data
        collection.

        See https://docs.sleap.ai/latest/help/#usage for more information.
    """
    import threading

    analytics_data = get_analytics_data()

    def _ping_analytics():
        try:
            requests.post(
                ANALYTICS_ENDPOINT,
                json=analytics_data,
            )
        except (requests.ConnectionError, requests.Timeout):
            pass

    # Fire and forget.
    threading.Thread(target=_ping_analytics).start()