gslides-automator 0.4.0__py3-none-any.whl

gslides_automator-0.4.0.dist-info/METADATA

@@ -0,0 +1,131 @@
+Metadata-Version: 2.4
+Name: gslides_automator
+Version: 0.4.0
+Summary: Generate data and reports from Google Sheets and Drive
+Project-URL: Homepage, https://github.com/rvignesh89/gslides_automator
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE.txt
+Requires-Dist: gspread>=5.0.0
+Requires-Dist: google-auth>=2.0.0
+Requires-Dist: google-auth-httplib2>=0.1.0
+Requires-Dist: google-api-python-client>=2.0.0
+Requires-Dist: pandas>=1.5.0
+Provides-Extra: dev
+Dynamic: license-file
+
+# Google Slides Automator
+
+This repository contains a python package / binary for generating multiple Google Slide reports in Google Drive by copying data from Google sheets. This package can be used to a automate pdf report generation by first modifying placeholders ({{placeholder}}) in a Google Slide with data and converting the slide to a report.
+
+Following elements in a slide can be replaced,
+1. Text placeholders in a paragraph
+2. Charts
+3. Tables
+4. Pictures
+
+The real value of this package is the ability to generate a report for different entities. By providing the raw data for each entity the package in a structure format the code can generate reports for each entitiy automatically.
+
+## Getting Started
+
+Requirements to running the reports are:
+
+1. Python 3.12 or above.
+2. Google Sheets, Slides and Drive API enabled service account credentials.
+3. Access to Google Drive Shared Drive containing slide and data templates and L0 data.
+
+### Service Account Setup
+
+1. Create a service account in Google Cloud Console with the following scopes:
+   - https://www.googleapis.com/auth/spreadsheets
+   - https://www.googleapis.com/auth/drive.readonly
+   - https://www.googleapis.com/auth/drive.file
+   - https://www.googleapis.com/auth/drive
+   - https://www.googleapis.com/auth/presentations
+2. Download the JSON key file and save it as `service-account-credentials.json` in the project root
+3. **Important**: Share all required Google Drive files and folders with the service account email (found in the JSON file as `client_email`) with **Editor** permissions
+   - This includes all folders (L0-Data, L1-Data, output folders)
+   - All template files (spreadsheets, presentations)
+   - For Shared Drives, add the service account as a member with appropriate permissions
+
+If you see "File not found" errors when trying to delete files, it means the service account doesn't have access to those files. The error messages will include the service account email that needs to be granted access.
+
+## How it works
+
+The package works exclusively on Google Drive files only. One of the inputs to the package functions will be a Google Drive folder id. It expects the Google Drive to have the exact structure.
+
+```
+/
+├── L0-Raw/
+│   ├── entity-1/
+│   │   ├── s1-table-performance.csv
+│   │   ├── s2-chart-profit.csv
+│   │   ├── s3-picture-distribution.png
+│   │   └── ...
+│   ├── entity-2/
+│   │   ├── s1-table-performance.csv
+│   │   ├── s2-chart-profit.csv
+│   │   ├── s2-picture-distribution.png
+│   │   └── ...
+│   └── ...
+├── L1-Merged/
+│   ├── entity-1/
+│   │   ├── entity-1.gsheet
+│   │   ├── s3-picture-distribution.png
+│   ├── entity-2/
+│   │   ├── entity-2.gsheet
+│   │   ├── s3-picture-distribution.png
+│   └── ...
+├── L2-Slide/
+│   ├── entity-1.gslide
+│   ├── entity-2.gslide
+│   └── ...
+├── L3-Pdf/
+│   ├── entity-1.pdf
+│   ├── entity-2.pdf
+│   └── ...
+├── templates/
+│   ├── slide-template.gslide
+│   ├── data-template.gsheet
+│   └── ...
+└── entities.csv
+```
+
+- **entities.csv** - Two columns: first column is the entity name; the second column `generate` controls processing. Rows with `generate` set to `Y` are processed, while `N` (or blank) rows are skipped. The first row is treated as a header.
+
+- **templates/** - This folder contains 2 files. A data template gsheet file and a slide template gslide file.
+
+The data template is will have multiple sheets. Each sheet will have the data for a single element (chart/table/picture). One sheet will have data for a element and there can be multiple elements in a sheet.
+
+The main purpose of template is to create charts to be embedded into the Google Slide report.
+
+- **L3-Pdf/**: Pdf reports for each entity. These are generated by converting the Google Slide reports to pdf.
+
+- **L2-Slide/**: Google Slide reports for each entity. These are generated by copying the slide template and replacing the placeholders with the data from the L1-Data sheet. This folder will have one slide per entity.
+
+- **L1-Merged/**: Processed and structured data—one spreadsheet per entity, used to generate charts. This folder will have sub folders for each entity. Each entity folder will have a spreadsheet for each slide and also the pictures used in the slides.
+
+- **L0-Raw/**: Raw input data for each entity. This folder will have sub folders for each entity. Each entity folder will have the raw data for each slide and also the pictures used in the slides.
+
+To understand the data better refer to the drive below which contains sample data for a couple of bike dealers.
+
+https://drive.google.com/drive/u/0/folders/1EaaTMa5H6EOuWMom_4iE6RZ51qWYf2af
+
+### Why is L0-Raw needed?
+
+Technically if you are able to generate data in the L1-Merged structure you do not need L0-Raw. However, not all languages have good API's to interact with Google Sheets like R. So to be compatible in such scenarios the library provides L0-Raw as just csv files. But if have the ability to generate merged datat for L1, skip L0 data generation.
+
+## Steps to use the libary
+
+WIP
+
+## Future work
+
+- Distribute as binary for OSX (brew), Windows (nuget)

gslides_automator-0.4.0.dist-info/RECORD

@@ -0,0 +1,13 @@
+gslides_automator/__init__.py,sha256=M3WFqSvO_rXCTs0vqfBDst_CfBYVkjXAjztMJU3gokI,1268
+gslides_automator/__main__.py,sha256=tpfodmg8j5bfNWeFkglZ8z4bzyWbwEG5Equ6XC2G0ZU,160
+gslides_automator/auth.py,sha256=sWzsunyV_qYsouBO-4H8mTAmJBhnICCOpEtsACc2Q6E,3627
+gslides_automator/cli.py,sha256=A-J_mo07DVcFmaatTIaMv4hZg3hYmOSW3rBmzQ3bJKg,3053
+gslides_automator/drive_layout.py,sha256=ooUZ0H0bg8J6oGI5EWiXtZq0BxVRnVbR296b2OQRyeI,7231
+gslides_automator/generate_data.py,sha256=CiBNLJcgk7P4LUTFDBnK_Ea-C0SE6RyNrl7MWVIqVhM,32784
+gslides_automator/generate_report.py,sha256=F6pDisT-Ldg0YZn7WXefFVj5Q9zDWlv_MYjbb9FF2rU,125631
+gslides_automator-0.4.0.dist-info/licenses/LICENSE.txt,sha256=pAZXnNE2dxxwXFIduGyn1gpvPefJtUYOYZOi3yeGG94,1068
+gslides_automator-0.4.0.dist-info/METADATA,sha256=ISLT19Fr2i5qfafwZCWS4Ng9mqq2vM8UTnfm1z5iSwQ,6208
+gslides_automator-0.4.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+gslides_automator-0.4.0.dist-info/entry_points.txt,sha256=Nj2M5Qx5zN19a9aLpc7DeJ5mIPCedWK3NyxYrU2w0R4,65
+gslides_automator-0.4.0.dist-info/top_level.txt,sha256=3IDhIJ9O_sAtz5VZv9rBfLRY5f-vTeD0Yz8qdmMXhjU,18
+gslides_automator-0.4.0.dist-info/RECORD,,

gslides_automator-0.4.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.9.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

gslides_automator-0.4.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+gslides_automator = gslides_automator.cli:main

gslides_automator-0.4.0.dist-info/licenses/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) [year] [fullname]
+
+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.

gslides_automator-0.4.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+gslides_automator