-
Notifications
You must be signed in to change notification settings - Fork 1.5k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Make 'containeranalysis/docs/README.rst' a symlink. * DRY 'phishinprotection/docs/index.rst', include changelog. * Update 'monitoring/README.rst' to use googleapis.dev URL. See #8993.
- Loading branch information
Showing
6 changed files
with
17 additions
and
153 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
../README.rst |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
../README.rst |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
../CHANGELOG.md |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,83 +1,20 @@ | ||
Python Client for Phishing Protection API (`Alpha`_) | ||
==================================================== | ||
.. include:: README.rst | ||
|
||
`Phishing Protection API`_: | ||
|
||
- `Client Library Documentation`_ | ||
- `Product Documentation`_ | ||
|
||
.. _Alpha: https://github.com/googleapis/google-cloud-python/blob/master/README.rst | ||
.. _Phishing Protection API: https://cloud.google.com/phishingprotection | ||
.. _Client Library Documentation: https://googleapis.dev/python/phishingprotection/latest | ||
.. _Product Documentation: https://cloud.google.com/phishingprotection | ||
|
||
Quick Start | ||
----------- | ||
|
||
In order to use this library, you first need to go through the following steps: | ||
|
||
1. `Select or create a Cloud Platform project.`_ | ||
2. `Enable billing for your project.`_ | ||
3. `Enable the Phishing Protection API.`_ | ||
4. `Setup Authentication.`_ | ||
|
||
.. _Select or create a Cloud Platform project.: https://console.cloud.google.com/project | ||
.. _Enable billing for your project.: https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project | ||
.. _Enable the Phishing Protection API.: https://cloud.google.com/phishingprotection | ||
.. _Setup Authentication.: https://googleapis.dev/python/phishingprotection/latest | ||
|
||
Installation | ||
~~~~~~~~~~~~ | ||
|
||
Install this library in a `virtualenv`_ using pip. `virtualenv`_ is a tool to | ||
create isolated Python environments. The basic problem it addresses is one of | ||
dependencies and versions, and indirectly permissions. | ||
|
||
With `virtualenv`_, it's possible to install this library without needing system | ||
install permissions, and without clashing with the installed system | ||
dependencies. | ||
|
||
.. _`virtualenv`: https://virtualenv.pypa.io/en/latest/ | ||
|
||
|
||
Mac/Linux | ||
^^^^^^^^^ | ||
|
||
.. code-block:: console | ||
pip install virtualenv | ||
virtualenv <your-env> | ||
source <your-env>/bin/activate | ||
<your-env>/bin/pip install google-cloud-phishingprotection | ||
Windows | ||
^^^^^^^ | ||
|
||
.. code-block:: console | ||
Api Reference | ||
------------- | ||
.. toctree:: | ||
:maxdepth: 2 | ||
|
||
pip install virtualenv | ||
virtualenv <your-env> | ||
<your-env>\Scripts\activate | ||
<your-env>\Scripts\pip.exe install google-cloud-phishingprotection | ||
gapic/v1beta1/api | ||
gapic/v1beta1/types | ||
|
||
Next Steps | ||
~~~~~~~~~~ | ||
|
||
- Read the `Client Library Documentation`_ for Phishing Protection API | ||
API to see other available methods on the client. | ||
- Read the `Phishing Protection API Product documentation`_ to learn | ||
more about the product and see How-to Guides. | ||
- View this `repository’s main README`_ to see the full list of Cloud | ||
APIs that we cover. | ||
Changelog | ||
---------- | ||
|
||
.. _Phishing Protection API Product documentation: https://cloud.google.com/phishingprotection | ||
.. _repository’s main README: https://github.com/googleapis/google-cloud-python/blob/master/README.rst | ||
For all previous ``google-cloud-phishingprotection`` releases: | ||
|
||
Api Reference | ||
------------- | ||
.. toctree:: | ||
:maxdepth: 2 | ||
|
||
gapic/v1beta1/api | ||
gapic/v1beta1/types | ||
changelog |