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