Python Client for Virtual Private Cloud
|stable| |pypi| |versions|
Virtual Private Cloud
_: provides networking functionality to Compute Engine virtual machine (VM) instances, Google Kubernetes Engine (GKE) containers, and the App Engine flexible environment. VPC provides networking for your cloud-based services that is global, scalable, and flexible.
Client Library Documentation
_Product Documentation
_
.. |stable| image:: https://img.shields.io/badge/support-stable-gold.svg
:target: https://github.com/googleapis/google-cloud-python/blob/main/README.rst#stability-levels
.. |pypi| image:: https://img.shields.io/pypi/v/google-cloud-vpc-access.svg
:target: https://pypi.org/project/google-cloud-vpc-access/
.. |versions| image:: https://img.shields.io/pypi/pyversions/google-cloud-vpc-access.svg
:target: https://pypi.org/project/google-cloud-vpc-access/
.. _Virtual Private Cloud: https://cloud.google.com/vpc/
.. _Client Library Documentation: https://cloud.google.com/python/docs/reference/vpcaccess/latest
.. _Product Documentation: https://cloud.google.com/vpc/
Quick Start
In order to use this library, you first need to go through the following steps:
Select or create a Cloud Platform project.
_Enable billing for your project.
_Enable the Virtual Private Cloud.
_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 Virtual Private Cloud.: https://cloud.google.com/vpc/
.. _Setup Authentication.: https://googleapis.dev/python/google-api-core/latest/auth.html
Installation
Install this library in a virtual environment using `venv`_. `venv`_ is a tool that
creates isolated Python environments. These isolated environments can have separate
versions of Python packages, which allows you to isolate one project's dependencies
from the dependencies of other projects.
With `venv`_, it's possible to install this library without needing system
install permissions, and without clashing with the installed system
dependencies.
.. _`venv`: https://docs.python.org/3/library/venv.html
Code samples and snippets
Code samples and snippets live in the samples/
_ folder.
.. _samples/: https://github.com/googleapis/google-cloud-python/tree/main/packages/google-cloud-vpc-access/samples
Supported Python Versions
^^^^^^^^^^^^^^^^^^^^^^^^^
Our client libraries are compatible with all current active
_ and maintenance
_ versions of
Python.
Python >= 3.7
.. _active: https://devguide.python.org/devcycle/#in-development-main-branch
.. _maintenance: https://devguide.python.org/devcycle/#maintenance-branches
Unsupported Python Versions
^^^^^^^^^^^^^^^^^^^^^^^^^^^
Python <= 3.6
If you are using an end-of-life
_
version of Python, we recommend that you update as soon as possible to an actively supported version.
.. _end-of-life: https://devguide.python.org/devcycle/#end-of-life-branches
Mac/Linux
^^^^^^^^^
.. code-block:: console
python3 -m venv <your-env>
source <your-env>/bin/activate
pip install google-cloud-vpc-access
Windows
^^^^^^^
.. code-block:: console
py -m venv <your-env>
.\<your-env>\Scripts\activate
pip install google-cloud-vpc-access
Next Steps
- Read the `Client Library Documentation`_ for Virtual Private Cloud
to see other available methods on the client.
- Read the `Virtual Private Cloud 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.
.. _Virtual Private Cloud Product documentation: https://cloud.google.com/vpc/
.. _README: https://github.com/googleapis/google-cloud-python/blob/main/README.rst