Skip to content

Commit

Permalink
Separate OPT_OUT_PROMPT from OPT_OUT_COPY
Browse files Browse the repository at this point in the history
Not all Python applications will use a CLI interface; for non-CLI
applications, the content of the new `OPT_OUT_PROMPT` constant would be
irrelevant. This separation enables `OPT_OUT_COPY` to be used more
widely, and `OPT_OUT_PROMPT` to be used when it makes sense.
  • Loading branch information
PSalant726 committed Apr 7, 2022
1 parent 247de72 commit 78877a7
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 4 deletions.
2 changes: 1 addition & 1 deletion fideslog/sdk/python/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ conda install fideslog
| :memo: Note | See Ethyca's [Guidelines for Establishing User Consent](../../../README.md#guidelines-for-establishing-user-consent) for a list of requirements for collecting analytics. |
|:-----------:|:---|

It is recommended to display the content of the [`OPT_OUT_COPY` constant](https://github.com/ethyca/fideslog/blob/3dcebe735a64286d8638435a55094fbd020c153b/fideslog/sdk/python/utils.py#L9-L19) as a means of prompting users to opt in or out of analytics data collection **as early as possible within the usage workflow of the application**.
It is recommended to display the content of the `OPT_OUT_COPY` constant exposed by [the `utils.py` file](./utils.py) as a means of informing users of the application's intent to collect analytics data **as early as possible within the usage workflow of the application**. If the application uses a CLI interface, the content of the `OPT_OUT_PROMPT` constant (also exposed by [the `utils.py` file](./utils.py)) can be displayed to collect explicit consent.

If the application is stateful, store the user's response within the top-level state-maintaining mechanism.

Expand Down
4 changes: 1 addition & 3 deletions fideslog/sdk/python/utils.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,11 @@
Fides needs your permission to send Ethyca a limited set of anonymous usage statistics.
Ethyca will only use this anonymous usage data to improve the product experience, and will never collect sensitive or personal data.
***
Don't believe us? Check out the open-source code here:
https://github.com/ethyca/fideslog
***
To opt-out of all telemetry, press "n". To continue with telemetry, press any other key.
"""
OPT_OUT_PROMPT = 'To opt out of all telemetry, press "n". To continue with telemetry, press any other key.'


def generate_client_id(application: bytes) -> str:
Expand Down

0 comments on commit 78877a7

Please sign in to comment.