|
1 # -*- coding: utf-8 -*- |
|
2 |
|
3 # Copyright (c) 2017 - 2022 Detlev Offenbach <detlev@die-offenbachs.de> |
|
4 # |
|
5 |
|
6 """ |
|
7 Package implementing the safe browsing functionality. |
|
8 """ |
|
9 |
|
10 |
|
11 def SafeBrowsingHelp(): |
|
12 """ |
|
13 Module function to get some help about how to enable the Google Mail |
|
14 OAuth2 service. |
|
15 |
|
16 @return help text |
|
17 @rtype str |
|
18 """ |
|
19 return ( |
|
20 "<h2>Steps to get a Google Safe Browsing API key</h2>" |
|
21 "<p>In order to use Google Safe Browsing you need a Google Account," |
|
22 " a Google Developer Console project, and an API key. You also need" |
|
23 " to activate the Safe Browsing APIs for use with your project.</p>" |
|
24 "<ol>" |
|
25 "<li>Google Account<br/>You need a Google Account in order to create" |
|
26 " a project. If you don't already have an account, sign up at" |
|
27 " <a href='https://accounts.google.com/SignUp'>Create your Google" |
|
28 " Account</a>.</li>" |
|
29 "<li>Developer Console Project<br/>You need a Google Developer Console" |
|
30 " project in order to create an API key. If you don't already have a" |
|
31 " project, see" |
|
32 " <a href='https://support.google.com/cloud/answer/6251787?hl=en'>" |
|
33 "Create, shut down, and restore projects</a>.</li>" |
|
34 "<li>API Key<br/>You need an API key to access the Safe Browsing APIs." |
|
35 " An API key authenticates you as an API user and allows you to" |
|
36 " interact with the APIs. To set up an API key, see " |
|
37 "<a href='https://support.google.com/cloud/answer/6158862" |
|
38 "?hl=en&ref_topic=6262490'>Setting up API keys</a>. Your new API key" |
|
39 " appears in a table. Copy and paste this key into the line edit above" |
|
40 " the button used to show this help.</li>" |
|
41 "<li>Activate the API<br/>Finally, you need to activate the Safe" |
|
42 " Browsing API for use with your project. To learn how to do this, see" |
|
43 " <a href='https://support.google.com/cloud/answer/6158841?hl=en'>" |
|
44 "Activate and deactivate APIs</a>. The API to enable is referred to as" |
|
45 " "Google Safe Browsing API".</li>" |
|
46 "</ol>" |
|
47 ) |