WebBrowser/SafeBrowsing/__init__.py

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

eric ide

mercurial