Skip to main content

A python library for authenticating requests for various google services including ``gmail``, ``youtube``, ``drive`` and ``calendar``.

Project description

gVerify

Overview

A python library for authenticating requests for various google services including gmail, youtube, drive and calendar.

Requirements

  • Python 3.10+
  • Works on Linux, Windows, macOS, BSD

Getting started

Getting an access key

To get started with this library, you need a google account in order to obtain access credentials. First, pick a service that you want to use, which could be: - gmail - youtube - drive - calendar

Installing the library

The next step is to instal the library from pypi:

pip install gverify

Authorizing a request

In this case we will use youtube as the service. We will authorize a request to search youtube for python programming videos:

from gverify import GoogleOAuth, YouTubeScopes

client_secret_file: str = 'client_secret.json'
api_service_name: str = 'youtube'
api_version: str = 'v3'
credentials_dir: str = '.youtube'
scopes: list[str] = [YouTubeScopes.youtube.value]
oauth: GoogleOAuth = GoogleOAuth(
    secrets_file=secret_file,
    scopes=scopes,
    api_service_name=api_service_name,
    api_version=api_version,
    credentials_dir=credentials_dir
)
youtube_client = oauth.authenticate_google_server()
youtube_find_request = youtube_client.search().list(q='python programming videos', part='id, snippet')
print(youtube_find_request.execute())

Using the Flask Framework

Currently, this library does not intergrate with web frameworks like Flask and fastAPI. To use flask, we use the underlying library:

from flask import Flask, url_for, redirect, request, session
from google_auth_oauthlib.flow import Flow
from google.oauth2.credentials import Credentials
import os


CLIENT_SECRETS_FILE = "client_secret.json"
SCOPES = [
    'https://www.googleapis.com/auth/youtube.force-ssl',
    'https://www.googleapis.com/auth/youtube'
]
API_SERVICE_NAME = 'youtube'
API_VERSION = 'v3'

app: Flask = Flask(__name__)
app.secret_key = 'secret-key'


@app.route('/')
def home():
    if not session['credentials']:
        redirect(url_for('authorize'))
    return 'Home'


@app.route('/authorize')
def authorize():
    flow = Flow.from_client_secrets_file(
      CLIENT_SECRETS_FILE,
      scopes=SCOPES
      )
    flow.redirect_uri = url_for('oauth2callback', _external=True)
    authorization_url, state = flow.authorization_url(
      access_type='offline',
      include_granted_scopes='true'
    )
    session['state'] = state
    return redirect(authorization_url)


def credentials_to_dict(credentials: Credentials) -> dict:
  return {
            'token': credentials.token,
          'refresh_token': credentials.refresh_token,
          'token_uri': credentials.token_uri,
          'client_id': credentials.client_id,
          'client_secret': credentials.client_secret,
          'scopes': credentials.scopes
          }


@app.route('/oauth2callback')
def oauth2callback():
    state = session['state']
    flow = Flow.from_client_secrets_file(
      CLIENT_SECRETS_FILE,
      scopes=SCOPES,
      state=state
    )
    flow.redirect_uri = url_for('oauth2callback', _external=True)
    authorization_response = request.url
    flow.fetch_token(authorization_response=authorization_response)
    credentials: Credentials = flow.credentials
    session['credentials'] = credentials_to_dict(credentials)
    return redirect('/')


if __name__ == '__main__':
    os.environ['OAUTHLIB_INSECURE_TRANSPORT'] = '1'
    app.run('localhost', 5000, debug=True)

How to Contribute

To contribute, chack out the contribution guideline.

License

The API uses an MIT License

Developer

Lyle Okoth – @lyleokoth on twitter

lyle okoth on medium

My email is lyceokoth@gmail.com

Here is my GitHub Profile

You can also find me on Linkedin

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

gverify-0.2.2.tar.gz (6.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

gverify-0.2.2-py3-none-any.whl (6.4 kB view details)

Uploaded Python 3

File details

Details for the file gverify-0.2.2.tar.gz.

File metadata

  • Download URL: gverify-0.2.2.tar.gz
  • Upload date:
  • Size: 6.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.3

File hashes

Hashes for gverify-0.2.2.tar.gz
Algorithm Hash digest
SHA256 7dd5ab18000e4c321288b93dba70f4d3a68c096d3eb5b6688ec0d9f588ec3e30
MD5 22bc216a7f861c11849bfa599b4c8e61
BLAKE2b-256 470aa4ea69849e479a8d623d5f6ba807362a7799231695c045ceefddf85e3d11

See more details on using hashes here.

File details

Details for the file gverify-0.2.2-py3-none-any.whl.

File metadata

  • Download URL: gverify-0.2.2-py3-none-any.whl
  • Upload date:
  • Size: 6.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.3

File hashes

Hashes for gverify-0.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 788db33fa5504cc57c39d76ca53f9ea4699b8e63feb5289c60941a2dce12bd89
MD5 098447e029325ac2aa13da015bd16118
BLAKE2b-256 ac850314cc7c7dac9f108d19fbfbd8f8af10ccb7f504d91c2e6b71131eb9ef19

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page