Skip to main content

A Python package to load and manage Google Sheets, Excel files, or any spreadsheet data from URLs and file paths.

Project description

Sheets Manager

Sheets Manager is a lightweight Python package designed for loading and managing data from Google Sheets, fetching data from all tabs within the file. This package provides a simple interface for accessing and storing tabular data in JSON format.


Features

  • Load All Tabs: Fetch data from all tabs within a spreadsheet automatically.
  • Easy to Use: Minimal setup to integrate into your projects.
  • Lightweight: No unnecessary dependencies—uses only pandas and json.

Installation

You can install Sheets Manager via pip:

pip install sheetsmanager

Usage

Initializing the Manager

from sheetsmanager import SheetsManager

# Initialize the SheetsManager with your Google Sheet ID
sheet_id = "your_google_sheet_id"
SheetsManager.init(sheet_id)

The SheetsManager will automatically load all data from all tabs in the spreadsheet upon initialization. Note: The sheet_data and sheet_url variables are static, meaning they are shared across all instances of the SheetsManager class.

Accessing the Loaded Data

# Access the loaded data as a dictionary
print(SheetsManager.sheet_data)  # Dictionary where keys are tab names and values are the tab data

Since sheet_data is a static variable, it will store the data globally, allowing all references to SheetsManager to access the same data.

Reloading the Data

If you want to reload the data from the Google Sheet and update all stored data, you can call the reload() method:

# Reload data from the spreadsheet
SheetsManager.reload()

This will refresh the sheet_data dictionary with the latest data from all tabs. The sheet_data variable is static, so any update will affect all instances that reference it.


Parameters

force_string (optional)

  • Type: bool
  • Default: False
  • Description: Forces all values to be returned as strings when loading data. If force_string=True, numerical values will be stored as strings.

Example Usage:

# Example usage with force_string
SheetsManager.init(sheet_id, force_string=True)

This ensures that all values remain in string format, which can be useful for preserving formatting from Google Sheets.


Getting the Sheet ID and Generating the URL

To use a Google Sheet with this package, you need the Sheet ID. Follow these steps:

Step 1: Open the Google Sheet

  1. Go to Google Sheets and open your spreadsheet.

Step 2: Retrieve the Sheet ID from the Publish to Web Dialog

  1. Click on File in the top menu.
  2. Select Share > Publish to the web.
  3. In the dialog that opens, you will see the Sheet ID in the generated URL. It looks like this:
    https://docs.google.com/spreadsheets/d/{SHEET_ID}/pub?output=xlsx
    
  4. Copy the part between /d/ and /pub—this is your Sheet ID.

Step 3: Publish the Google Sheet

  1. In the same dialog, choose:
    • Entire Document: To make all tabs available.
    • Microsoft Excel (.xlsx) as the file format.
  2. Click Publish and confirm your choice.

Important Warning

  • Public Access: Publishing makes the spreadsheet accessible to anyone with the link.
  • Read-Only: Others can download the file but cannot directly edit it.

Requirements

  • Python 3.7+
  • pandas

Contributing

Contributions are welcome! If you encounter bugs, have feature requests, or want to contribute code, feel free to submit issues and pull requests on GitHub.


License

Sheets Manager is licensed under the MIT License. See the LICENSE file for more details.

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

sheetsmanager-0.1.0.tar.gz (5.1 kB view details)

Uploaded Source

Built Distribution

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

sheetsmanager-0.1.0-py3-none-any.whl (5.4 kB view details)

Uploaded Python 3

File details

Details for the file sheetsmanager-0.1.0.tar.gz.

File metadata

  • Download URL: sheetsmanager-0.1.0.tar.gz
  • Upload date:
  • Size: 5.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.0

File hashes

Hashes for sheetsmanager-0.1.0.tar.gz
Algorithm Hash digest
SHA256 6751ac20cd56ad5364ab146e3707c3dac235e8a670abd0098c347c9996ed65db
MD5 c4d8df64089b0161c3c12b97fe208383
BLAKE2b-256 1f685af7ebba7036083d5f579bc66bd922e4453d5348624692737015f8e2e514

See more details on using hashes here.

File details

Details for the file sheetsmanager-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: sheetsmanager-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 5.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.0

File hashes

Hashes for sheetsmanager-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 bf9538a5968060c697e2fe4317154d96dd9bd74fb8d6ab2a60ade70c5199b73c
MD5 2294a5108b84f22ed148008d43f11e0f
BLAKE2b-256 f8f61699d678c22a3e1e0ce79091139b6b7a1bdb3a3f89a89cb562fa17e334e2

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