Skip to content

Commit b82a9f0

Browse files
committed
Update usage section of documentation
1 parent db4db78 commit b82a9f0

File tree

1 file changed

+13
-4
lines changed

1 file changed

+13
-4
lines changed

docs/usage.rst

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -111,17 +111,26 @@ To interact with servers requiring certificate-based authentication, you can pro
111111
To interact with a server of the Google Healthcare API requiring OpenID Connect based authentication and authorization, provide a session authenticated using the Google Cloud Platform (GCP) credentials.
112112
See `GCP documentation <https://cloud.google.com/docs/authentication/production>`_ for details.
113113

114-
Note that GCP authentication requires installation of the package distribution with the ``gcp`` extra requirements: ``$ pip install dicomweb-client[gcp]``.
114+
The library provides the ``gcp`` extension, which facilitates interacting with the DICOMweb interface of the Google Healthcare API.
115+
Note that the ``gcp`` extension is optional and requires installation of the package distribution with the ``gcp`` extra requirements: ``$ pip install dicomweb-client[gcp]``.
115116

116117
.. code-block:: python
117118
118119
from dicomweb_client.api import DICOMwebClient
119-
from dicomweb_client.session_utils import create_session_from_gcp_credentials
120+
from dicomweb_client.ext.gcp.session_utils import create_session_from_gcp_credentials
121+
from dicomweb_client.ext.gcp.uri import GoogleCloudHealthcareURL
120122
121123
session = create_session_from_gcp_credentials()
122124
125+
url = GoogleCloudHealthcareURL(
126+
project_id='my-project',
127+
location='us-east4',
128+
dataset_id='my-dataset',
129+
dicom_store_id='my-store'
130+
)
131+
123132
client = DICOMwebClient(
124-
url="https://mydicomwebserver.com",
133+
url=str(url),
125134
session=session
126135
)
127136
@@ -258,7 +267,7 @@ Search for series filtering by *Modality*:
258267

259268
.. code-block:: python
260269
261-
series = client.search_for_series(search_filters={'Modality': 'CT'})
270+
series = client.search_for_series(search_filters={'Modality': 'SM'})
262271
263272
264273
.. _searchforinstances:

0 commit comments

Comments
 (0)