Skip to content

Commit

Permalink
Updating readme to reflect the module owrks as of Oct 2022.
Browse files Browse the repository at this point in the history
  • Loading branch information
asweigart committed Oct 10, 2022
1 parent 8a6de49 commit 0fdcfc9
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 5 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# EZGmail

A Pythonic interface to the Gmail API that actually works as of September 2022.
A Pythonic interface to the Gmail API that actually works as of October 2022.

The official Gmail API quickstart doesn't actually seem to work on Python 3 without some adjustments, and the entire documentation is a bit much for someone who just wants to read and send emails from their Gmail account. I created EZGmail as a simple module that just works.

Expand All @@ -12,7 +12,7 @@ To install with pip, run:

pip install ezgmail

You will need to download a credentials file and set up Google Cloud services using your Gmail account. If you have a Gmail account, you can do this and it is free (unless you are making large use of the Gmail API by sending out thousands of emails every day.) There's several steps to this, detailed in the following sections. These instructions were last updated September 2022.
For your Python script to use EZGmail to access Gmail account, you need a credentials JSON file and a token JSON file. This requires a one-time set up on Google Cloud services using your Gmail account. If you have a Gmail account, you can do this and it is free (unless you are making large use of the Gmail API by sending out thousands of emails every day.) There's several steps to this, detailed in the following sections. These instructions were last updated September 2022.

### Create a new Google Cloud Project

Expand Down
3 changes: 2 additions & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
with open('README.md') as fo:
content = fo.read()
long_description = content
description = re.search('(A Pythonic interface to.*)', content).group(1)
description = re.search('(A Pythonic interface to.*)', content).group(1) # Grab the description from the top comment.

setup(
name='EZGmail',
Expand Down Expand Up @@ -38,5 +38,6 @@
'Programming Language :: Python :: 3.8',
'Programming Language :: Python :: 3.9',
'Programming Language :: Python :: 3.10',
'Programming Language :: Python :: 3.11',
],
)
4 changes: 2 additions & 2 deletions src/ezgmail/__init__.py
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
"""EZGmail - A Pythonic interface to the Gmail API."""
"""EZGmail - A Pythonic interface to the Gmail API that actually works as of October 2022."""

# By Al Sweigart al@inventwithpython.com
# Note: Unless you know what you're doing, also use the default 'me' value for userId parameters in this module.


__version__ = "2022.09.14"
__version__ = "2022.10.10"

"""
NOTES FOR DEVELOPERS AND CONTRIBUTORS:
Expand Down

0 comments on commit 0fdcfc9

Please sign in to comment.