Skip to content

πŸ“Š An interactive Google Sheet explorer for Jupyter & Colab. (From Arabic 'Jadwal' meaning Table).

License

Notifications You must be signed in to change notification settings

marzzuki/ipyjadwal

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

22 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

ipyjadwal πŸ“Š

PyPI version License: MIT Python Code style: black

ipyjadwal (derived from the Arabic Jadwal Ψ¬ΩŽΨ―Ω’ΩˆΩŽΩ„ meaning "Table" or "Schedule") is a clean, interactive Jupyter widget for browsing Google Sheets directly inside Google Colab or Jupyter Notebooks.

It simplifies the workflow of selecting spreadsheets, switching sheets, and previewing DataFrames without writing repetitive boilerplate code.

Watch the video

Installation

pip install ipyjadwal

Usage

import ipyjadwal

widget = ipyjadwal.Jadwal()
widget.show()

# Access selected data as pandas DataFrame
df = widget.df

# Write updates back using gspread
widget.sheet.update_cell(1, 1, "New Value")

For local Jupyter Notebooks, provide a gspread client:

import gspread
import ipyjadwal

gc = gspread.service_account("credentials.json")
widget = ipyjadwal.Jadwal(client=gc)
widget.show()

✨ Features

  • πŸ” Easy Google Auth (Colab-friendly)
    No boilerplate setup in Google Colab, authentication just works out of the box.

  • πŸ” Spreadsheet Picker
    Select any Google Drive spreadsheet from a searchable dropdown.

  • πŸ“‘ Sheet Switching
    Loads available worksheets automatically when a file is selected.

  • 🐼 Data Access
    Access the sheet data as a pandas DataFrame via widget.df.

  • ✏️ gspread Access
    Use the raw gspread sheet object through widget.sheet.

πŸ”§ Documentation

API Reference

Jadwal(client=None, sort_method="default")

Main widget class for browsing Google Sheets.

Parameters

  • client (optional): An authorized gspread client. If None, attempts automatic authentication in Google Colab.
  • sort_method: "default" (default), "asc", or "dsc" β€” Sort order for the file list.

Properties

  • df: pandas DataFrame containing the full data from the currently selected sheet.
  • sheet: gspread worksheet object for the currently selected sheet β€” use this to write back to Google Sheets.

Methods

  • show(): Display the interactive widget.

Links

License

This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgments

About

πŸ“Š An interactive Google Sheet explorer for Jupyter & Colab. (From Arabic 'Jadwal' meaning Table).

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages