|
1 | | -Python Client for Web Security Scanner API (`Alpha`_) |
2 | | -===================================================== |
3 | | - |
4 | | -`Web Security Scanner API`_: Web Security Scanner API (under development). |
5 | | - |
6 | | -- `Client Library Documentation`_ |
7 | | -- `Product Documentation`_ |
8 | | - |
9 | | -.. _Alpha: https://github.com/GoogleCloudPlatform/google-cloud-python/blob/master/README.rst |
10 | | -.. _Web Security Scanner API: https://cloud.google.com/security-scanner |
11 | | -.. _Client Library Documentation: https://googlecloudplatform.github.io/google-cloud-python/stable/websecurityscanner/usage.html |
12 | | -.. _Product Documentation: https://cloud.google.com/security-scanner |
13 | | - |
14 | | -Quick Start |
15 | | ------------ |
16 | | - |
17 | | -In order to use this library, you first need to go through the following steps: |
18 | | - |
19 | | -1. `Select or create a Cloud Platform project.`_ |
20 | | -2. `Enable billing for your project.`_ |
21 | | -3. `Enable the Web Security Scanner API.`_ |
22 | | -4. `Setup Authentication.`_ |
23 | | - |
24 | | -.. _Select or create a Cloud Platform project.: https://console.cloud.google.com/project |
25 | | -.. _Enable billing for your project.: https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project |
26 | | -.. _Enable the Web Security Scanner API.: https://cloud.google.com/security-scanner |
27 | | -.. _Setup Authentication.: https://googlecloudplatform.github.io/google-cloud-python/stable/core/auth.html |
28 | | - |
29 | | -Installation |
30 | | -~~~~~~~~~~~~ |
31 | | - |
32 | | -Install this library in a `virtualenv`_ using pip. `virtualenv`_ is a tool to |
33 | | -create isolated Python environments. The basic problem it addresses is one of |
34 | | -dependencies and versions, and indirectly permissions. |
35 | | - |
36 | | -With `virtualenv`_, it's possible to install this library without needing system |
37 | | -install permissions, and without clashing with the installed system |
38 | | -dependencies. |
39 | | - |
40 | | -.. _`virtualenv`: https://virtualenv.pypa.io/en/latest/ |
41 | | - |
42 | | - |
43 | | -Mac/Linux |
44 | | -^^^^^^^^^ |
45 | | - |
46 | | -.. code-block:: console |
47 | | -
|
48 | | - pip install virtualenv |
49 | | - virtualenv <your-env> |
50 | | - source <your-env>/bin/activate |
51 | | - <your-env>/bin/pip install google-cloud-websecurityscanner |
52 | | -
|
53 | | -
|
54 | | -Windows |
55 | | -^^^^^^^ |
56 | | - |
57 | | -.. code-block:: console |
58 | | -
|
59 | | - pip install virtualenv |
60 | | - virtualenv <your-env> |
61 | | - <your-env>\Scripts\activate |
62 | | - <your-env>\Scripts\pip.exe install google-cloud-websecurityscanner |
63 | | -
|
64 | | -Next Steps |
65 | | -~~~~~~~~~~ |
66 | | - |
67 | | -- Read the `Client Library Documentation`_ for Web Security Scanner API |
68 | | - API to see other available methods on the client. |
69 | | -- Read the `Web Security Scanner API Product documentation`_ to learn |
70 | | - more about the product and see How-to Guides. |
71 | | -- View this `repository’s main README`_ to see the full list of Cloud |
72 | | - APIs that we cover. |
73 | | - |
74 | | -.. _Web Security Scanner API Product documentation: https://cloud.google.com/security-scanner |
75 | | -.. _repository’s main README: https://github.com/GoogleCloudPlatform/google-cloud-python/blob/master/README.rst |
| 1 | +.. include:: /../websecurityscanner/README.rst |
76 | 2 |
|
77 | 3 | Api Reference |
78 | 4 | ------------- |
79 | 5 | .. toctree:: |
80 | 6 | :maxdepth: 2 |
81 | 7 |
|
82 | 8 | gapic/v1alpha/api |
83 | | - gapic/v1alpha/types |
| 9 | + gapic/v1alpha/types |
0 commit comments