Python Client for Discovery Engine API
======================================
|preview| |pypi| |versions|
`Discovery Engine API`_:
- `Client Library Documentation`_
- `Product Documentation`_
.. |preview| image:: https://img.shields.io/badge/support-preview-orange.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-discoveryengine.svg
:target: https://pypi.org/project/google-cloud-discoveryengine/
.. |versions| image:: https://img.shields.io/pypi/pyversions/google-cloud-discoveryengine.svg
:target: https://pypi.org/project/google-cloud-discoveryengine/
.. _Discovery Engine API: https://cloud.google.com/discovery-engine/
.. _Client Library Documentation: https://cloud.google.com/python/docs/reference/discoveryengine/latest/summary_overview
.. _Product Documentation: https://cloud.google.com/discovery-engine/
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 Discovery Engine 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 Discovery Engine API.: https://cloud.google.com/discovery-engine/
.. _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-discoveryengine/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-discoveryengine
Windows
^^^^^^^
.. code-block:: console
py -m venv <your-env>
.\<your-env>\Scripts\activate
pip install google-cloud-discoveryengine
Next Steps
~~~~~~~~~~
- Read the `Client Library Documentation`_ for Discovery Engine API
to see other available methods on the client.
- Read the `Discovery Engine API 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.
.. _Discovery Engine API Product documentation: https://cloud.google.com/discovery-engine/
.. _README: https://github.com/googleapis/google-cloud-python/blob/main/README.rst
Raw data
{
"_id": null,
"home_page": "https://github.com/googleapis/google-cloud-python/tree/main/packages/google-cloud-discoveryengine",
"name": "google-cloud-discoveryengine",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": null,
"author": "Google LLC",
"author_email": "googleapis-packages@google.com",
"download_url": "https://files.pythonhosted.org/packages/14/a7/0a9932a02603c9d39ce59ea1d8843e5a18f4a723bab97a4ec421931f67dc/google_cloud_discoveryengine-0.13.3.tar.gz",
"platform": "Posix; MacOS X; Windows",
"description": "Python Client for Discovery Engine API\n======================================\n\n|preview| |pypi| |versions|\n\n`Discovery Engine API`_: \n\n- `Client Library Documentation`_\n- `Product Documentation`_\n\n.. |preview| image:: https://img.shields.io/badge/support-preview-orange.svg\n :target: https://github.com/googleapis/google-cloud-python/blob/main/README.rst#stability-levels\n.. |pypi| image:: https://img.shields.io/pypi/v/google-cloud-discoveryengine.svg\n :target: https://pypi.org/project/google-cloud-discoveryengine/\n.. |versions| image:: https://img.shields.io/pypi/pyversions/google-cloud-discoveryengine.svg\n :target: https://pypi.org/project/google-cloud-discoveryengine/\n.. _Discovery Engine API: https://cloud.google.com/discovery-engine/\n.. _Client Library Documentation: https://cloud.google.com/python/docs/reference/discoveryengine/latest/summary_overview\n.. _Product Documentation: https://cloud.google.com/discovery-engine/\n\nQuick Start\n-----------\n\nIn order to use this library, you first need to go through the following steps:\n\n1. `Select or create a Cloud Platform project.`_\n2. `Enable billing for your project.`_\n3. `Enable the Discovery Engine API.`_\n4. `Setup Authentication.`_\n\n.. _Select or create a Cloud Platform project.: https://console.cloud.google.com/project\n.. _Enable billing for your project.: https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project\n.. _Enable the Discovery Engine API.: https://cloud.google.com/discovery-engine/\n.. _Setup Authentication.: https://googleapis.dev/python/google-api-core/latest/auth.html\n\nInstallation\n~~~~~~~~~~~~\n\nInstall this library in a virtual environment using `venv`_. `venv`_ is a tool that\ncreates isolated Python environments. These isolated environments can have separate\nversions of Python packages, which allows you to isolate one project's dependencies\nfrom the dependencies of other projects.\n\nWith `venv`_, it's possible to install this library without needing system\ninstall permissions, and without clashing with the installed system\ndependencies.\n\n.. _`venv`: https://docs.python.org/3/library/venv.html\n\n\nCode samples and snippets\n~~~~~~~~~~~~~~~~~~~~~~~~~\n\nCode samples and snippets live in the `samples/`_ folder.\n\n.. _samples/: https://github.com/googleapis/google-cloud-python/tree/main/packages/google-cloud-discoveryengine/samples\n\n\nSupported Python Versions\n^^^^^^^^^^^^^^^^^^^^^^^^^\nOur client libraries are compatible with all current `active`_ and `maintenance`_ versions of\nPython.\n\nPython >= 3.7\n\n.. _active: https://devguide.python.org/devcycle/#in-development-main-branch\n.. _maintenance: https://devguide.python.org/devcycle/#maintenance-branches\n\nUnsupported Python Versions\n^^^^^^^^^^^^^^^^^^^^^^^^^^^\nPython <= 3.6\n\nIf you are using an `end-of-life`_\nversion of Python, we recommend that you update as soon as possible to an actively supported version.\n\n.. _end-of-life: https://devguide.python.org/devcycle/#end-of-life-branches\n\nMac/Linux\n^^^^^^^^^\n\n.. code-block:: console\n\n python3 -m venv <your-env>\n source <your-env>/bin/activate\n pip install google-cloud-discoveryengine\n\n\nWindows\n^^^^^^^\n\n.. code-block:: console\n\n py -m venv <your-env>\n .\\<your-env>\\Scripts\\activate\n pip install google-cloud-discoveryengine\n\nNext Steps\n~~~~~~~~~~\n\n- Read the `Client Library Documentation`_ for Discovery Engine API\n to see other available methods on the client.\n- Read the `Discovery Engine API Product documentation`_ to learn\n more about the product and see How-to Guides.\n- View this `README`_ to see the full list of Cloud\n APIs that we cover.\n\n.. _Discovery Engine API Product documentation: https://cloud.google.com/discovery-engine/\n.. _README: https://github.com/googleapis/google-cloud-python/blob/main/README.rst\n",
"bugtrack_url": null,
"license": "Apache 2.0",
"summary": "Google Cloud Discoveryengine API client library",
"version": "0.13.3",
"project_urls": {
"Homepage": "https://github.com/googleapis/google-cloud-python/tree/main/packages/google-cloud-discoveryengine"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "be41297d22bf94557547faa34bb7a6934105f08f95a0a19cd6158704bcc0548c",
"md5": "7a01000df76729711e09aa421a6d655e",
"sha256": "9b54996f283fe464d8e28342f6600f08684f880c504166fd515289aabca94d55"
},
"downloads": -1,
"filename": "google_cloud_discoveryengine-0.13.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7a01000df76729711e09aa421a6d655e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 2676421,
"upload_time": "2024-10-31T16:53:24",
"upload_time_iso_8601": "2024-10-31T16:53:24.610870Z",
"url": "https://files.pythonhosted.org/packages/be/41/297d22bf94557547faa34bb7a6934105f08f95a0a19cd6158704bcc0548c/google_cloud_discoveryengine-0.13.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "14a70a9932a02603c9d39ce59ea1d8843e5a18f4a723bab97a4ec421931f67dc",
"md5": "ccc7ff011ff85d4608329cc2924ff411",
"sha256": "91fa830983cca71aa0d052066fdc5adae0df81559141eaf2b0040325a36b1fd6"
},
"downloads": -1,
"filename": "google_cloud_discoveryengine-0.13.3.tar.gz",
"has_sig": false,
"md5_digest": "ccc7ff011ff85d4608329cc2924ff411",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 2902571,
"upload_time": "2024-10-31T16:53:26",
"upload_time_iso_8601": "2024-10-31T16:53:26.249714Z",
"url": "https://files.pythonhosted.org/packages/14/a7/0a9932a02603c9d39ce59ea1d8843e5a18f4a723bab97a4ec421931f67dc/google_cloud_discoveryengine-0.13.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-31 16:53:26",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "googleapis",
"github_project": "google-cloud-python",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "google-cloud-discoveryengine"
}
JSON
