Metadata-Version: 2.3
Name: pythonic_gmail
Version: 0.1.2
Summary: An example project generated by cookiecutter-pywf_open_source.
License: MIT
Author: Sanhe Hu
Author-email: husanhe@email.com
Maintainer: Sanhe Hu
Maintainer-email: husanhe@email.com
Requires-Python: >=3.10,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Provides-Extra: auto
Provides-Extra: dev
Provides-Extra: doc
Provides-Extra: test
Requires-Dist: Sphinx (>=7.4.7,<8.0.0) ; extra == "doc"
Requires-Dist: build (>=1.2.1,<2.0.0) ; extra == "dev"
Requires-Dist: docfly (==3.0.0) ; extra == "doc"
Requires-Dist: enum-mate (>=0.1.1,<1.0.0)
Requires-Dist: func-args (>=1.0.1,<2.0.0)
Requires-Dist: furo (==2024.8.6) ; extra == "doc"
Requires-Dist: google-api-python-client (>=2.157.0,<3.0.0)
Requires-Dist: google-api-python-client-stubs (>=1.29.0,<2.0.0) ; extra == "dev"
Requires-Dist: google-auth-httplib2 (>=0.2.0,<1.0.0)
Requires-Dist: google-auth-oauthlib (>=1.2.1,<2.0.0)
Requires-Dist: ipython (>=8.18.1,<8.19.0) ; extra == "doc"
Requires-Dist: iterproxy (>=0.3.1,<1.0.0)
Requires-Dist: more-itertools (>=10.6.0) ; python_version < "3.12"
Requires-Dist: nbsphinx (>=0.8.12,<1.0.0) ; extra == "doc"
Requires-Dist: pygments (>=2.18.0,<3.0.0) ; extra == "doc"
Requires-Dist: pytest (>=8.2.2,<9.0.0) ; extra == "test"
Requires-Dist: pytest-cov (>=6.0.0,<7.0.0) ; extra == "test"
Requires-Dist: rich (>=13.8.1,<14.0.0) ; extra == "dev"
Requires-Dist: rstobj (==1.2.1) ; extra == "doc"
Requires-Dist: sphinx-copybutton (>=0.5.2,<1.0.0) ; extra == "doc"
Requires-Dist: sphinx-design (>=0.6.1,<1.0.0) ; extra == "doc"
Requires-Dist: sphinx-jinja (>=2.0.2,<3.0.0) ; extra == "doc"
Requires-Dist: twine (>=6.0.0,<7.0.0) ; extra == "dev"
Requires-Dist: typing-extensions (>=4.0.0,<5.0.0) ; python_version < "3.11"
Requires-Dist: wheel (>=0.45.0,<1.0.0) ; extra == "dev"
Project-URL: Changelog, https://github.com/MacHu-GWU/pythonic_gmail-project/blob/main/release-history.rst
Project-URL: Documentation, https://pythonic-gmail.readthedocs.io/en/latest/
Project-URL: Download, https://pypi.org/pypi/pythonic-gmail#files
Project-URL: Homepage, https://github.com/MacHu-GWU/pythonic_gmail-project
Project-URL: Issues, https://github.com/MacHu-GWU/pythonic_gmail-project/issues
Project-URL: Repository, https://github.com/MacHu-GWU/pythonic_gmail-project
Description-Content-Type: text/x-rst


.. image:: https://readthedocs.org/projects/pythonic-gmail/badge/?version=latest
    :target: https://pythonic-gmail.readthedocs.io/en/latest/
    :alt: Documentation Status

.. image:: https://github.com/MacHu-GWU/pythonic_gmail-project/actions/workflows/main.yml/badge.svg
    :target: https://github.com/MacHu-GWU/pythonic_gmail-project/actions?query=workflow:CI

.. image:: https://codecov.io/gh/MacHu-GWU/pythonic_gmail-project/branch/main/graph/badge.svg
    :target: https://codecov.io/gh/MacHu-GWU/pythonic_gmail-project

.. image:: https://img.shields.io/pypi/v/pythonic-gmail.svg
    :target: https://pypi.python.org/pypi/pythonic-gmail

.. image:: https://img.shields.io/pypi/l/pythonic-gmail.svg
    :target: https://pypi.python.org/pypi/pythonic-gmail

.. image:: https://img.shields.io/pypi/pyversions/pythonic-gmail.svg
    :target: https://pypi.python.org/pypi/pythonic-gmail

.. image:: https://img.shields.io/badge/✍️_Release_History!--None.svg?style=social&logo=github
    :target: https://github.com/MacHu-GWU/pythonic_gmail-project/blob/main/release-history.rst

.. image:: https://img.shields.io/badge/⭐_Star_me_on_GitHub!--None.svg?style=social&logo=github
    :target: https://github.com/MacHu-GWU/pythonic_gmail-project

------

.. image:: https://img.shields.io/badge/Link-API-blue.svg
    :target: https://pythonic-gmail.readthedocs.io/en/latest/py-modindex.html

.. image:: https://img.shields.io/badge/Link-Install-blue.svg
    :target: `install`_

.. image:: https://img.shields.io/badge/Link-GitHub-blue.svg
    :target: https://github.com/MacHu-GWU/pythonic_gmail-project

.. image:: https://img.shields.io/badge/Link-Submit_Issue-blue.svg
    :target: https://github.com/MacHu-GWU/pythonic_gmail-project/issues

.. image:: https://img.shields.io/badge/Link-Request_Feature-blue.svg
    :target: https://github.com/MacHu-GWU/pythonic_gmail-project/issues

.. image:: https://img.shields.io/badge/Link-Download-blue.svg
    :target: https://pypi.org/pypi/pythonic-gmail#files


Welcome to ``pythonic_gmail`` Documentation
==============================================================================
.. image:: https://pythonic-gmail.readthedocs.io/en/latest/_static/pythonic_gmail-logo.png
    :target: https://pythonic-gmail.readthedocs.io/en/latest/

**A Pythonic object-oriented wrapper for the Gmail API**

``pythonic_gmail`` transforms the traditional Google Gmail API client into an intuitive, object-oriented interface that follows Python best practices. While the native Gmail API returns raw JSON dictionaries, this library provides structured data models with property-based access, automatic pagination handling, and efficient batch operations.

**Key Features:**

**Object-Oriented Data Models**: All Gmail API responses are wrapped in frozen dataclasses with property-based access. Instead of accessing ``response["messages"][0]["id"]``, you simply use ``message.id``. Each model maintains the original raw data while providing a clean, type-safe interface with intelligent property caching.

**Intelligent Pagination**: Gmail's pagination mechanism with ``pageToken`` and ``nextPageToken`` is completely abstracted away. The library provides iterator proxies that handle token management automatically, allowing you to focus on processing data rather than managing API pagination state.

**Efficient Batch Operations**: Built-in batch processing utilities automatically group individual API calls into efficient batch requests. This significantly reduces HTTP overhead when retrieving multiple messages or threads, improving performance for bulk operations.

**Stable Interface Design**: The library implements a core data extraction pattern where each model exposes essential information through a standardized ``core_data`` property. This provides resilience against API schema changes while maintaining a consistent developer experience.

**Flexible Iterator Architecture**: Advanced iterator proxies support both response-level iteration (for processing API responses in batches) and item-level iteration (for processing individual messages or threads). This dual-mode approach provides flexibility for different use cases and performance requirements.


.. _install:

Install
------------------------------------------------------------------------------

``pythonic_gmail`` is released on PyPI, so all you need is to:

.. code-block:: console

    $ pip install pythonic-gmail

To upgrade to latest version:

.. code-block:: console

    $ pip install --upgrade pythonic-gmail

