Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Share usage data #1038

Merged
merged 12 commits into from
Nov 10, 2022
Merged

Share usage data #1038

merged 12 commits into from
Nov 10, 2022

Conversation

talmo
Copy link
Collaborator

@talmo talmo commented Nov 10, 2022

Description

Add functionality to share basic usage data on GUI launch.

See docs for more info:

  • https://sleap.ai/help.html#usage-data
  • sleap/docs/help.md

    Lines 124 to 130 in 21dea31

    ### What is usage data?
    To help us improve SLEAP, you may allow us to collect basic and **anonymous** usage data. If enabled from the **Help** menu, the SLEAP GUI will transmit information such as which version of Python and operating system you are running SLEAP on.
    This helps us understand on which types of computers SLEAP is being used so we can ensure that our software is maximally accessible to the broadest userbase possible, for example, by telling us whether it's safe to update our dependencies without breaking SLEAP for most users. Collecting usage data also helps us get a sense for how often SLEAP is being used so that we can report its impact to external grant funding agencies.
    You can opt out at any time from the menu (this preference will be stored). If you want to prevent these data from being shared with us, you can launch the GUI with `sleap-label --no-usage-data`. Usage data is only shared when the GUI is used, not the API or CLIs.

Types of changes

  • Bugfix
  • New feature
  • Refactor / Code style update (no logical changes)
  • Build / CI changes
  • Documentation Update
  • Other (explain)

Does this address any currently open issues?

[list open issues here]

Outside contributors checklist

  • Review the guidelines for contributing to this repository
  • Read and sign the CLA and add yourself to the authors list
  • Make sure you are making a pull request against the develop branch (not main). Also you should start your branch off develop
  • Add tests that prove your fix is effective or that your feature works
  • Add necessary documentation (if appropriate)

Thank you for contributing to SLEAP!

❤️

@talmo talmo requested a review from roomrys November 10, 2022 04:01
@talmo talmo marked this pull request as ready for review November 10, 2022 04:04
@codecov
Copy link

codecov bot commented Nov 10, 2022

Codecov Report

Merging #1038 (1592b84) into develop (7dc80a6) will increase coverage by 0.02%.
The diff coverage is 84.84%.

@@             Coverage Diff             @@
##           develop    #1038      +/-   ##
===========================================
+ Coverage    66.74%   66.77%   +0.02%     
===========================================
  Files          127      127              
  Lines        21527    21557      +30     
===========================================
+ Hits         14368    14394      +26     
- Misses        7159     7163       +4     
Impacted Files Coverage Δ
sleap/prefs.py 86.48% <ø> (ø)
sleap/gui/app.py 76.94% <80.00%> (+0.13%) ⬆️
sleap/gui/web.py 83.75% <88.88%> (ø)

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@roomrys roomrys merged commit 7782155 into develop Nov 10, 2022
@roomrys roomrys deleted the talmo/telemetry branch November 10, 2022 18:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants