gsr 1.0.0__tar.gz

gsr-1.0.0/.gitignore

@@ -0,0 +1,211 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+#poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer,
+#  you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# dev files
+dev/
+main.py
+
+# API token files
+credentials*.json
+client*.json
+*.csv
+token.json

gsr-1.0.0/LICENSE

@@ -0,0 +1,7 @@
+Copyright 2025 ritonun
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

gsr-1.0.0/PKG-INFO

@@ -0,0 +1,53 @@
+Metadata-Version: 2.4
+Name: gsr
+Version: 1.0.0
+Summary: Google Sheet Downloader
+Project-URL: Homepage, https://github.com/ritonun/gsr
+Project-URL: Issues, https://github.com/ritonun/gsr/issues
+Author-email: ritonun <73615644+ritonun@users.noreply.github.com>
+License-Expression: MIT
+License-File: LICENSE
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.12
+Requires-Dist: google-api-python-client==2.172.0
+Requires-Dist: google-auth-httplib2==0.2.0
+Requires-Dist: google-auth-oauthlib==1.2.2
+Description-Content-Type: text/markdown
+
+# Google Sheet Reader
+
+Connect to your google sheet and export data.
+
+To get your API token:
+[Google Sheet Python quickstart](https://developers.google.com/workspace/sheets/api/quickstart/python)
+
+## Install
+```bash
+python3 -m venv .venv
+source .venv/bin/activate
+pip install --upgrade google-api-python-client google-auth-httplib2 google-auth-oauthlib
+```
+
+## Example
+```python
+import gsr
+
+if __name__ == '__main__':
+    SHEET_ID = 'YOUR_SHEET_ID'
+    creds = gsr.get_credentials()   # your creds should be name `credentials.json` and put in your working folder
+
+    for range in ["Sheet1", "Sheet2", "Sheet3"]: # your sheet name
+        print(f"GET {range}")
+
+        values = gsr.connect_to_sheet(creds, SHEET_ID, range)
+
+        if values is None:
+            print(f"Error getting {range}, check your SHEET_ID or range")
+        else:
+            filename = 'csv_' + range + '.csv'
+            with open(filename, 'w') as f:
+                for row in values:
+                    text = str(row) + '\n'
+                    f.write(text)
+```

gsr-1.0.0/README.md

@@ -0,0 +1,36 @@
+# Google Sheet Reader
+
+Connect to your google sheet and export data.
+
+To get your API token:
+[Google Sheet Python quickstart](https://developers.google.com/workspace/sheets/api/quickstart/python)
+
+## Install
+```bash
+python3 -m venv .venv
+source .venv/bin/activate
+pip install --upgrade google-api-python-client google-auth-httplib2 google-auth-oauthlib
+```
+
+## Example
+```python
+import gsr
+
+if __name__ == '__main__':
+    SHEET_ID = 'YOUR_SHEET_ID'
+    creds = gsr.get_credentials()   # your creds should be name `credentials.json` and put in your working folder
+
+    for range in ["Sheet1", "Sheet2", "Sheet3"]: # your sheet name
+        print(f"GET {range}")
+
+        values = gsr.connect_to_sheet(creds, SHEET_ID, range)
+
+        if values is None:
+            print(f"Error getting {range}, check your SHEET_ID or range")
+        else:
+            filename = 'csv_' + range + '.csv'
+            with open(filename, 'w') as f:
+                for row in values:
+                    text = str(row) + '\n'
+                    f.write(text)
+```

gsr-1.0.0/gsr/__init__.py

@@ -0,0 +1 @@
+from .gapi import *

gsr-1.0.0/gsr/gapi.py

@@ -0,0 +1,57 @@
+# google api
+
+import os.path
+
+from google.auth.transport.requests import Request
+from google.oauth2.credentials import Credentials
+from google_auth_oauthlib.flow import InstalledAppFlow
+from googleapiclient.discovery import build
+from googleapiclient.errors import HttpError
+
+SCOPES = ["https://www.googleapis.com/auth/spreadsheets.readonly"]
+
+def get_credentials():
+    creds = None
+    # token.json automatically created upon first connection. check if it exist
+    if os.path.exists("token.json"):
+        creds = Credentials.from_authorized_user_file("token.json", SCOPES)
+
+    # if cred are not valid
+    if not creds or not creds.valid:
+        print('not valid cred')
+        if creds and creds.expired and creds.refresh_token:
+          creds.refresh(Request())
+        else:
+            print('cred')
+            flow = InstalledAppFlow.from_client_secrets_file(
+                "credentials.json", SCOPES
+            )
+            creds = flow.run_local_server(port=0)
+            # Save the credentials for the next run
+            with open("token.json", "w") as token:
+                token.write(creds.to_json())
+    return creds
+
+
+def connect_to_sheet(creds: Credentials, spreadsheet_id: str, range: str):
+    try:
+        service = build("sheets", "v4", credentials=creds)
+
+        # Call the Sheets API
+        sheet = service.spreadsheets()
+        result = (
+            sheet.values()
+            .get(spreadsheetId=spreadsheet_id, range=range)
+            .execute()
+        )
+        values = result.get("values", [])
+
+        if not values:
+            print("No data found.")
+            return None
+
+        return values
+
+    except HttpError as err:
+        print(err)
+        return None

gsr-1.0.0/pyproject.toml

@@ -0,0 +1,28 @@
+[project]
+name = "gsr"
+version = "1.0.0"
+authors = [
+    { name = "ritonun", email = "73615644+ritonun@users.noreply.github.com" },
+]
+description = "Google Sheet Downloader"
+readme = "README.md"
+requires-python = ">=3.12"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Operating System :: OS Independent",
+]
+license = "MIT"
+license-files = ["LICEN[CS]E*"]
+dependencies = [
+    "google-api-python-client==2.172.0",
+    "google-auth-httplib2==0.2.0",
+    "google-auth-oauthlib==1.2.2",
+]
+
+[project.urls]
+Homepage = "https://github.com/ritonun/gsr"
+Issues = "https://github.com/ritonun/gsr/issues"
+
+[build-system]
+requires = ["hatchling >= 1.26"]
+build-backend = "hatchling.build"