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
45 changes: 34 additions & 11 deletions README.rst
Original file line number Diff line number Diff line change
@@ -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 <https://developers.google.com/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/ <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/ <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
-----------
Expand Down Expand Up @@ -72,7 +89,7 @@ character.
Issue tracker
-------------

https://github.com/googleads/data-manager-python/issues
* https://github.com/googleads/data-manager-python/issues

Contributing
------------
Expand All @@ -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
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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"

Expand Down
Loading