From b51064148c171727105bb3af4b5e78dcad536840 Mon Sep 17 00:00:00 2001 From: Josh Radcliff Date: Mon, 28 Sep 2026 12:58:39 -0400 Subject: [PATCH] docs: highlight package registry publication in README Change-Id: I99e47acfebc5c182effbc1d6dc5df108f1eff97e --- README.rst | 45 ++++++++++++++++++++++++++++++++++----------- pyproject.toml | 2 +- 2 files changed, 35 insertions(+), 12 deletions(-) diff --git a/README.rst b/README.rst index b61d4cc..df07053 100644 --- a/README.rst +++ b/README.rst @@ -1,23 +1,40 @@ -Data Manager API utilities and samples for Python -================================================= +Data Manager API utility library and samples for Python +======================================================= -Utilities and code samples for working with the Data Manager API and Python. +|pypi| + +Utility library and code samples for working with the +`Data Manager API `_ and Python. Requirements ------------ + * Python 3.10+ -Installation ------------- +Setup instructions +------------------ + +The ``google-ads-datamanager-util`` utility library is published to `PyPI`_. +Install it using ``pip``: .. code-block:: bash pip install google-ads-datamanager-util -Documentation -------------- -Please refer to our `Developer Site`_ for documentation on how to install, -configure, and use this client library. +For complete instructions on setting up API access and installing the client and +utility libraries, see the `Set up API access`_ and `Install a client library`_ +guides. + +Repository structure +-------------------- + +* `src/ `_: Source code for the ``google-ads-datamanager-util`` PyPI + package. Use the utilities in the library to help with common tasks like + formatting, hashing, encrypting, and encoding data for Data Manager API + requests. +* `samples/ `_: Code samples demonstrating how to construct and send + requests to the Data Manager API using the `google-ads-datamanager`_ client + library and the ``google-ads-datamanager-util`` utility library. Run samples ----------- @@ -72,7 +89,7 @@ character. Issue tracker ------------- -https://github.com/googleads/data-manager-python/issues +* https://github.com/googleads/data-manager-python/issues Contributing ------------ @@ -85,6 +102,12 @@ Authors * `Josh Radcliff`_ * `Lindsey Volta`_ -.. _Developer Site: https://developers.google.com/data-manager/api/get-started/set-up-access#python +.. |pypi| image:: https://img.shields.io/pypi/v/google-ads-datamanager-util.svg + :target: https://pypi.org/project/google-ads-datamanager-util/ + :alt: PyPI version +.. _PyPI: https://pypi.org/project/google-ads-datamanager-util/ +.. _Set up API access: https://developers.google.com/data-manager/api/devguides/quickstart/set-up-access +.. _Install a client library: https://developers.google.com/data-manager/api/devguides/quickstart/install-library#python +.. _google-ads-datamanager: https://pypi.org/project/google-ads-datamanager/ .. _Josh Radcliff: https://github.com/jradcliff .. _Lindsey Volta: https://github.com/lindsey-volta diff --git a/pyproject.toml b/pyproject.toml index 881b881..d90f672 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -47,7 +47,7 @@ dependencies = [ [project.urls] Homepage = "https://github.com/googleads/data-manager-python" -Documentation = "https://developers.google.com/data-manager/api/get-started/set-up-access#python" +Documentation = "https://developers.google.com/data-manager/api/devguides/quickstart/install-library#python" Repository = "https://github.com/googleads/data-manager-python" "Issue Tracker" = "https://github.com/googleads/data-manager-python/issues"