Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
4d84b7d
commit 8aaa847
Showing
44 changed files
with
7,347 additions
and
239 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
[run] | ||
branch = True | ||
|
||
[report] | ||
fail_under = 100 | ||
show_missing = True | ||
omit = | ||
google/cloud/orgpolicy/__init__.py | ||
exclude_lines = | ||
# Re-enable the standard pragma | ||
pragma: NO COVER | ||
# Ignore debug-only repr | ||
def __repr__ | ||
# Ignore pkg_resources exceptions. | ||
# This is added at the module level as a safeguard for if someone | ||
# generates the code and tries to run it without pip installing. This | ||
# makes it virtually impossible to test properly. | ||
except pkg_resources.DistributionNotFound |
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,15 @@ | ||
{"allowedCopyrightHolders": ["Google LLC"], | ||
"allowedLicenses": ["Apache-2.0", "MIT", "BSD-3"], | ||
"ignoreFiles": ["**/requirements.txt", "**/requirements-test.txt"], | ||
"sourceFileExtensions": [ | ||
"ts", | ||
"js", | ||
"java", | ||
"sh", | ||
"Dockerfile", | ||
"yaml", | ||
"py", | ||
"html", | ||
"txt" | ||
] | ||
} |
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
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 |
---|---|---|
@@ -1,10 +1,12 @@ | ||
{ | ||
"name": "orgpolicy", | ||
"name_pretty": "Organization Policy", | ||
"product_documentation": "https://cloud.google.com/resource-manager/docs/organization-policy/overview", | ||
"client_documentation": "https://googleapis.dev/python/orgpolicy/latest", | ||
"issue_tracker": "https://github.com/googleapis/python-orgpolicy/issues", | ||
"issue_tracker": "", | ||
"release_level": "beta", | ||
"language": "python", | ||
"repo": "googleapis/python-org-policy", | ||
"distribution_name": "google-cloud-org-policy" | ||
"distribution_name": "google-cloud-org-policy", | ||
"api_id": "orgpolicy.googleapis.com" | ||
} |
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
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,83 @@ | ||
Python Client for Organization Policy | ||
================================================= | ||
|
||
|beta| |pypi| |versions| | ||
|
||
`Organization Policy`_: The Organization Policy API allows users to configure governance rules on their GCP | ||
resources across the Cloud Resource Hierarchy. | ||
|
||
- `Client Library Documentation`_ | ||
- `Product Documentation`_ | ||
|
||
.. |beta| image:: https://img.shields.io/badge/support-beta-orange.svg | ||
:target: https://github.com/googleapis/google-cloud-python/blob/master/README.rst#beta-support | ||
.. |pypi| image:: https://img.shields.io/pypi/v/google-cloud-org-policy.svg | ||
:target: https://pypi.org/project/google-cloud-org-policy/ | ||
.. |versions| image:: https://img.shields.io/pypi/pyversions/google-cloud-org-policy.svg | ||
:target: https://pypi.org/project/google-cloud-org-policy/ | ||
.. _Organization Policy: https://cloud.google.com/resource-manager/docs/organization-policy/overview | ||
.. _Client Library Documentation: https://googleapis.dev/python/orgpolicy/latest | ||
.. _Product Documentation: https://cloud.google.com/resource-manager/docs/organization-policy/overview | ||
|
||
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 Organization Policy 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 Organization Policy API.: https://cloud.google.com/resource-manager/docs/organization-policy/overview | ||
.. _Setup Authentication.: https://googleapis.dev/python/google-api-core/latest/auth.html | ||
|
||
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-org-policy | ||
Windows | ||
^^^^^^^ | ||
|
||
.. code-block:: console | ||
pip install virtualenv | ||
virtualenv <your-env> | ||
<your-env>\Scripts\activate | ||
<your-env>\Scripts\pip.exe install google-cloud-org-policy | ||
Next Steps | ||
~~~~~~~~~~ | ||
|
||
- Read the `Client Library Documentation`_ for Organization Policy | ||
to see other available methods on the client. | ||
- Read the `Organization Policy Product documentation`_ to learn | ||
more about the product and see How-to Guides. | ||
- View this `README`_ to see the full list of Cloud | ||
APIs that we cover. | ||
|
||
.. _Organization Policy Product documentation: https://cloud.google.com/resource-manager/docs/organization-policy/overview | ||
.. _README: https://github.com/googleapis/google-cloud-python/blob/master/README.rst |
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 |
---|---|---|
@@ -1,18 +1,23 @@ | ||
.. include:: README.md | ||
|
||
.. include:: README.rst | ||
|
||
.. include:: multiprocessing.rst | ||
|
||
API Reference | ||
------------- | ||
.. toctree:: | ||
:maxdepth: 2 | ||
|
||
v1 | ||
orgpolicy_v2/services | ||
orgpolicy_v2/types | ||
|
||
.. include:: multiprocessing.rst | ||
|
||
Changelog | ||
--------- | ||
|
||
For a list of all ``google-cloud-org-policy`` releases: | ||
|
||
.. toctree:: | ||
:maxdepth: 2 | ||
:maxdepth: 2 | ||
|
||
changelog | ||
changelog |
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,11 @@ | ||
OrgPolicy | ||
--------------------------- | ||
|
||
.. automodule:: google.cloud.orgpolicy_v2.services.org_policy | ||
:members: | ||
:inherited-members: | ||
|
||
|
||
.. automodule:: google.cloud.orgpolicy_v2.services.org_policy.pagers | ||
:members: | ||
:inherited-members: |
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,6 @@ | ||
Services for Google Cloud Orgpolicy v2 API | ||
========================================== | ||
.. toctree:: | ||
:maxdepth: 2 | ||
|
||
org_policy |
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,7 @@ | ||
Types for Google Cloud Orgpolicy v2 API | ||
======================================= | ||
|
||
.. automodule:: google.cloud.orgpolicy_v2.types | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.