Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion packages/google-cloud-workstations/.flake8
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# -*- coding: utf-8 -*-
#
# Copyright 2020 Google LLC
# Copyright 2023 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
Expand Down
30 changes: 15 additions & 15 deletions packages/google-cloud-workstations/.repo-metadata.json
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
{
"name": "workstations",
"name_pretty": "Cloud Workstations API",
"api_description": "Cloud Workstations API",
"product_documentation": "https://cloud.google.com/workstations/docs",
"client_documentation": "https://cloud.google.com/python/docs/reference/workstations/latest",
"issue_tracker": "https://issuetracker.google.com/issues/new?component=1328344",
"release_level": "preview",
"language": "python",
"library_type": "GAPIC_AUTO",
"repo": "googleapis/google-cloud-python",
"distribution_name": "google-cloud-workstations",
"api_id": "workstations.googleapis.com",
"default_version": "v1",
"codeowner_team": "",
"api_shortname": "workstations"
"name": "workstations",
"name_pretty": "Cloud Workstations",
"api_description": "",
"product_documentation": "https://cloud.google.com/workstations/",
"client_documentation": "https://cloud.google.com/python/docs/reference/workstations/latest",
"issue_tracker": "https://github.com/googleapis/google-cloud-python/issues",
"release_level": "preview",
"language": "python",
"library_type": "GAPIC_AUTO",
"repo": "googleapis/google-cloud-python",
"distribution_name": "google-cloud-workstations",
"api_id": "workstations.googleapis.com",
"default_version": "v1",
"codeowner_team": "",
"api_shortname": "workstations"
}
2 changes: 1 addition & 1 deletion packages/google-cloud-workstations/CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -236,7 +236,7 @@ We support:

Supported versions can be found in our ``noxfile.py`` `config`_.

.. _config: https://github.com/googleapis/google-cloud-python/blob/main/noxfile.py
.. _config: https://github.com/googleapis/google-cloud-python/blob/main/packages/google-cloud-workstations/noxfile.py


**********
Expand Down
2 changes: 1 addition & 1 deletion packages/google-cloud-workstations/MANIFEST.in
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# -*- coding: utf-8 -*-
#
# Copyright 2020 Google LLC
# Copyright 2023 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
Expand Down
47 changes: 24 additions & 23 deletions packages/google-cloud-workstations/README.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
Python Client for Cloud Workstations API
========================================
Python Client for Cloud Workstations
====================================

|preview| |pypi| |versions|

`Cloud Workstations API`_: Cloud Workstations API
`Cloud Workstations`_:

- `Client Library Documentation`_
- `Product Documentation`_
Expand All @@ -14,9 +14,9 @@ Python Client for Cloud Workstations API
:target: https://pypi.org/project/google-cloud-workstations/
.. |versions| image:: https://img.shields.io/pypi/pyversions/google-cloud-workstations.svg
:target: https://pypi.org/project/google-cloud-workstations/
.. _Cloud Workstations API: https://cloud.google.com/workstations/docs
.. _Cloud Workstations: https://cloud.google.com/workstations/
.. _Client Library Documentation: https://cloud.google.com/python/docs/reference/workstations/latest
.. _Product Documentation: https://cloud.google.com/workstations/docs
.. _Product Documentation: https://cloud.google.com/workstations/

Quick Start
-----------
Expand All @@ -25,32 +25,35 @@ 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 Cloud Workstations API.`_
3. `Enable the Cloud Workstations.`_
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 Cloud Workstations API.: https://cloud.google.com/workstations/docs
.. _Enable the Cloud Workstations.: https://cloud.google.com/workstations/
.. _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.
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 `virtualenv`_, it's possible to install this library without needing system
With `venv`_, 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/
.. _`venv`: https://docs.python.org/3/library/venv.html


Code samples and snippets
~~~~~~~~~~~~~~~~~~~~~~~~~

Code samples and snippets live in the `samples/` folder.
Code samples and snippets live in the `samples/`_ folder.

.. _samples/: https://github.com/googleapis/google-cloud-python/tree/main/packages/google-cloud-workstations/samples


Supported Python Versions
Expand All @@ -77,31 +80,29 @@ Mac/Linux

.. code-block:: console

pip install virtualenv
virtualenv <your-env>
python3 -m venv <your-env>
source <your-env>/bin/activate
<your-env>/bin/pip install google-cloud-workstations
pip install google-cloud-workstations


Windows
^^^^^^^

.. code-block:: console

pip install virtualenv
virtualenv <your-env>
<your-env>\Scripts\activate
<your-env>\Scripts\pip.exe install google-cloud-workstations
py -m venv <your-env>
.\<your-env>\Scripts\activate
pip install google-cloud-workstations

Next Steps
~~~~~~~~~~

- Read the `Client Library Documentation`_ for Cloud Workstations API
- Read the `Client Library Documentation`_ for Cloud Workstations
to see other available methods on the client.
- Read the `Cloud Workstations API Product documentation`_ to learn
- Read the `Cloud Workstations 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.

.. _Cloud Workstations API Product documentation: https://cloud.google.com/workstations/docs
.. _Cloud Workstations Product documentation: https://cloud.google.com/workstations/
.. _README: https://github.com/googleapis/google-cloud-python/blob/main/README.rst
2 changes: 1 addition & 1 deletion packages/google-cloud-workstations/docs/conf.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# -*- coding: utf-8 -*-
# Copyright 2021 Google LLC
# Copyright 2023 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
Expand Down
2 changes: 1 addition & 1 deletion packages/google-cloud-workstations/docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

.. include:: multiprocessing.rst

This package includes clients for multiple versions of Cloud Workstations API.
This package includes clients for multiple versions of Cloud Workstations.
By default, you will get version ``workstations_v1``.


Expand Down
2 changes: 1 addition & 1 deletion packages/google-cloud-workstations/noxfile.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# -*- coding: utf-8 -*-
#
# Copyright 2018 Google LLC
# Copyright 2023 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
#!/bin/bash

# Copyright 2015 Google Inc. All rights reserved.
# Copyright 2023 Google LLC All rights reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
Expand Down