gformbot 0.1.0__tar.gz

gformbot-0.1.0/LICENSE

@@ -0,0 +1,180 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship made available under
+      the License, as indicated by a copyright notice that is included in
+      or attached to the work (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other transformations
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean, as submitted to the Licensor for inclusion
+      in the Work by the copyright owner or by an individual or Legal Entity
+      authorized to submit on behalf of the copyright owner. For the purposes
+      of this definition, "submitted" means any form of electronic, verbal,
+      or written communication sent to the Licensor or its representatives,
+      including but not limited to communication on electronic mailing lists,
+      source code control systems, and issue tracking systems that are managed
+      by, or on behalf of, the Licensor for the purpose of discussing and
+      improving the Work, but excluding communication that is conspicuously
+      marked or designated in writing by the copyright owner as "Not a
+      Contribution."
+
+      "Contributor" shall mean Licensor and any Legal Entity on behalf of
+      whom a Contribution has been received by the Licensor and included
+      within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by the combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a cross-claim
+      or counterclaim in a lawsuit) alleging that the Work or any patent
+      claim embodied in the Work constitutes patent patent or contributory
+      patent infringement, then any patent licenses granted to You under
+      this License for that Work shall terminate as of the date such
+      litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or Derivative
+          Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, You must include a readable copy of the
+          attribution notices contained within such NOTICE file, in
+          at least one of the following places: within a NOTICE text file
+          distributed as part of the Derivative Works; within the Source
+          form or documentation, if provided along with the Derivative
+          Works; or, within a display generated by the Derivative Works,
+          if and wherever such third-party notices normally appear. The
+          contents of the NOTICE file are for informational purposes only
+          and do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own license statement for Your modifications and
+      may provide additional grant of rights to use, copy, modify, merge,
+      publish, distribute, sublicense, and/or sell copies of the Work,
+      subject to the terms and conditions of the License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or reproducing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or exemplary damages of any character arising as a result
+      of this License or out of the use or inability to use the Work
+      (including but not limited to damages for loss of goodwill, work
+      stoppage, computer failure or malfunction, or all other commercial
+      damages or losses), even if such Contributor has been advised of the
+      possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer, and
+      charge a fee for, acceptance of support, warranty, indemnity, or
+      other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may offer only
+      conditions consistent with this License, and may charge a fee for
+      acceptance of warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2024 yogeshkrishna
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

gformbot-0.1.0/PKG-INFO

@@ -0,0 +1,230 @@
+Metadata-Version: 2.4
+Name: gformbot
+Version: 0.1.0
+Summary: A general-purpose Google Form auto-filler CLI — inspect any form, supply a response pool, and submit at scale.
+Author: yogeshkrishna
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/yogeshkrishna/google_form_test_bot
+Project-URL: Repository, https://github.com/yogeshkrishna/google_form_test_bot
+Project-URL: Bug Tracker, https://github.com/yogeshkrishna/google_form_test_bot/issues
+Keywords: google-forms,automation,selenium,cli,bot
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Internet :: WWW/HTTP :: Browsers
+Classifier: Topic :: Software Development :: Testing
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: selenium<5,>=4.25
+Requires-Dist: click>=8.1
+Requires-Dist: pyyaml>=6.0
+Requires-Dist: rich>=13.0
+Requires-Dist: InquirerPy>=0.3.4
+Provides-Extra: clipboard
+Requires-Dist: pyperclip; extra == "clipboard"
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: build; extra == "dev"
+Requires-Dist: twine; extra == "dev"
+Dynamic: license-file
+
+# gformbot
+
+> **A general-purpose Google Form auto-filler CLI.**  
+> Inspect any form, supply a response pool (or let it generate synthetic answers), and submit at scale.
+
+---
+
+## Install
+
+```bash
+pip install gformbot
+```
+
+For clipboard URL detection (handy — just copy the form URL before running):
+
+```bash
+pip install "gformbot[clipboard]"
+```
+
+> **Requirements:** Python ≥ 3.9 · Google Chrome, Firefox, or Edge installed on your system.  
+> ChromeDriver / GeckoDriver are managed automatically by Selenium Manager (no manual download needed).
+
+---
+
+## Quick Start
+
+### Interactive wizard (recommended for new users)
+
+Just run:
+
+```bash
+gformbot
+```
+
+The wizard will:
+1. Detect if you have a Google Form URL on your clipboard — press Enter to use it.
+2. Auto-inspect the form (opens a hidden browser for ~10 seconds).
+3. Ask if you have a response CSV pool.
+4. Let you set count, browser, and headless preferences with arrow-key menus.
+5. Show a sample response preview.
+6. Submit responses with a live progress bar.
+
+---
+
+## Subcommands (power-user / scriptable)
+
+### Inspect a form and generate a config
+
+```bash
+gformbot inspect "https://docs.google.com/forms/d/e/YOUR_FORM_ID/viewform"
+```
+
+This opens a headless browser, scrapes all questions and options, and writes `gformbot_config.yaml` to the current directory.
+
+---
+
+### Fill a form
+
+```bash
+# Using wizard-generated config (auto-detected):
+gformbot fill
+
+# Explicit URL (auto-inspects and creates config):
+gformbot fill "https://docs.google.com/forms/d/e/YOUR_FORM_ID/viewform"
+
+# With all options:
+gformbot fill \
+  --config my_config.yaml \
+  --count 25 \
+  --pool my_responses.csv \
+  --browser chrome \
+  --headless
+```
+
+---
+
+### Preview responses without submitting
+
+```bash
+gformbot preview "https://..." --count 5
+```
+
+---
+
+### View or edit the config
+
+```bash
+gformbot config --show      # print to terminal
+gformbot config --edit      # open in $EDITOR
+```
+
+---
+
+### View the run log
+
+```bash
+gformbot log
+gformbot log --last 50
+```
+
+---
+
+## Config File (`gformbot_config.yaml`)
+
+Generated automatically by `gformbot inspect`. Customize it to set:
+
+```yaml
+url: https://docs.google.com/forms/d/e/YOUR_FORM_ID/viewform
+form_title: My Survey
+
+# Optional: path to a CSV of real responses (relative or absolute)
+pool_file: response_pool.csv
+
+run_settings:
+  count: 10
+  browser: auto          # auto | chrome | firefox | edge | headless
+  headless: false
+  min_delay: 0.25
+  max_delay: 0.75
+  max_runs: 500
+  log_file: gformbot_log.csv
+
+questions:
+  - index: 1
+    text: "What best describes your main daily activity?"
+    type: radio
+    options:
+      - Studying
+      - Mostly indoor work
+      - A mix of indoor and outdoor work
+      - Mostly outdoor work
+      - Retired or not currently working
+      - Other
+    # Optional: bias weights (parallel to options list)
+    weights: [85, 5, 7, 1, 1, 1]
+
+  - index: 8
+    text: "Which kinds of places felt hottest?"
+    type: checkbox
+    max_select: 3        # pick at most 3
+    options:
+      - Roads, footpaths or crossings
+      - Bus stops or transport waiting areas
+      - No particular hot spot / not sure
+
+  - index: 14
+    text: "Optional: Name one public place that needs more shade."
+    type: textarea
+    # Fixed list of texts to randomly pick from:
+    text_pool:
+      - ""
+      - "college bus stop"
+      - "campus main gate area"
+```
+
+---
+
+## Response Pool CSV
+
+The CSV just needs columns that loosely match your form's question texts.  
+The tool auto-maps columns by matching question text prefixes — no manual mapping needed.
+
+For multi-select questions, values in the CSV should be comma-separated:
+
+```
+Q8 column value: "Roads, footpaths or crossings, Bus stops or transport waiting areas"
+```
+
+---
+
+## Browser Support
+
+| Browser | Status | Notes |
+|---------|--------|-------|
+| Chrome / Chromium | ✅ Full | Default. Incognito mode. |
+| Firefox | ✅ Full | Private mode. |
+| Edge | ✅ Full | InPrivate mode. |
+| Headless | ✅ Full | Fastest. No window. Recommended for servers. |
+| Auto | ✅ | Detects your system default browser. Falls back to Chrome. |
+
+---
+
+## Tips
+
+- **`auto` browser mode** reads your OS default browser (Windows registry / macOS defaults / `xdg-settings`) and uses that. If detection fails or the browser isn't supported, it falls back to Chrome.
+- **Headless** is recommended for unattended / server runs.
+- **`max_runs`** in the config is a safety cap to prevent accidental mass submissions.
+- The tool stops immediately on the first error and logs it — it will never silently fail in a loop.
+
+---
+
+## License
+
+Apache 2.0 — see [LICENSE](LICENSE).

gformbot-0.1.0/README.md

@@ -0,0 +1,194 @@
+# gformbot
+
+> **A general-purpose Google Form auto-filler CLI.**  
+> Inspect any form, supply a response pool (or let it generate synthetic answers), and submit at scale.
+
+---
+
+## Install
+
+```bash
+pip install gformbot
+```
+
+For clipboard URL detection (handy — just copy the form URL before running):
+
+```bash
+pip install "gformbot[clipboard]"
+```
+
+> **Requirements:** Python ≥ 3.9 · Google Chrome, Firefox, or Edge installed on your system.  
+> ChromeDriver / GeckoDriver are managed automatically by Selenium Manager (no manual download needed).
+
+---
+
+## Quick Start
+
+### Interactive wizard (recommended for new users)
+
+Just run:
+
+```bash
+gformbot
+```
+
+The wizard will:
+1. Detect if you have a Google Form URL on your clipboard — press Enter to use it.
+2. Auto-inspect the form (opens a hidden browser for ~10 seconds).
+3. Ask if you have a response CSV pool.
+4. Let you set count, browser, and headless preferences with arrow-key menus.
+5. Show a sample response preview.
+6. Submit responses with a live progress bar.
+
+---
+
+## Subcommands (power-user / scriptable)
+
+### Inspect a form and generate a config
+
+```bash
+gformbot inspect "https://docs.google.com/forms/d/e/YOUR_FORM_ID/viewform"
+```
+
+This opens a headless browser, scrapes all questions and options, and writes `gformbot_config.yaml` to the current directory.
+
+---
+
+### Fill a form
+
+```bash
+# Using wizard-generated config (auto-detected):
+gformbot fill
+
+# Explicit URL (auto-inspects and creates config):
+gformbot fill "https://docs.google.com/forms/d/e/YOUR_FORM_ID/viewform"
+
+# With all options:
+gformbot fill \
+  --config my_config.yaml \
+  --count 25 \
+  --pool my_responses.csv \
+  --browser chrome \
+  --headless
+```
+
+---
+
+### Preview responses without submitting
+
+```bash
+gformbot preview "https://..." --count 5
+```
+
+---
+
+### View or edit the config
+
+```bash
+gformbot config --show      # print to terminal
+gformbot config --edit      # open in $EDITOR
+```
+
+---
+
+### View the run log
+
+```bash
+gformbot log
+gformbot log --last 50
+```
+
+---
+
+## Config File (`gformbot_config.yaml`)
+
+Generated automatically by `gformbot inspect`. Customize it to set:
+
+```yaml
+url: https://docs.google.com/forms/d/e/YOUR_FORM_ID/viewform
+form_title: My Survey
+
+# Optional: path to a CSV of real responses (relative or absolute)
+pool_file: response_pool.csv
+
+run_settings:
+  count: 10
+  browser: auto          # auto | chrome | firefox | edge | headless
+  headless: false
+  min_delay: 0.25
+  max_delay: 0.75
+  max_runs: 500
+  log_file: gformbot_log.csv
+
+questions:
+  - index: 1
+    text: "What best describes your main daily activity?"
+    type: radio
+    options:
+      - Studying
+      - Mostly indoor work
+      - A mix of indoor and outdoor work
+      - Mostly outdoor work
+      - Retired or not currently working
+      - Other
+    # Optional: bias weights (parallel to options list)
+    weights: [85, 5, 7, 1, 1, 1]
+
+  - index: 8
+    text: "Which kinds of places felt hottest?"
+    type: checkbox
+    max_select: 3        # pick at most 3
+    options:
+      - Roads, footpaths or crossings
+      - Bus stops or transport waiting areas
+      - No particular hot spot / not sure
+
+  - index: 14
+    text: "Optional: Name one public place that needs more shade."
+    type: textarea
+    # Fixed list of texts to randomly pick from:
+    text_pool:
+      - ""
+      - "college bus stop"
+      - "campus main gate area"
+```
+
+---
+
+## Response Pool CSV
+
+The CSV just needs columns that loosely match your form's question texts.  
+The tool auto-maps columns by matching question text prefixes — no manual mapping needed.
+
+For multi-select questions, values in the CSV should be comma-separated:
+
+```
+Q8 column value: "Roads, footpaths or crossings, Bus stops or transport waiting areas"
+```
+
+---
+
+## Browser Support
+
+| Browser | Status | Notes |
+|---------|--------|-------|
+| Chrome / Chromium | ✅ Full | Default. Incognito mode. |
+| Firefox | ✅ Full | Private mode. |
+| Edge | ✅ Full | InPrivate mode. |
+| Headless | ✅ Full | Fastest. No window. Recommended for servers. |
+| Auto | ✅ | Detects your system default browser. Falls back to Chrome. |
+
+---
+
+## Tips
+
+- **`auto` browser mode** reads your OS default browser (Windows registry / macOS defaults / `xdg-settings`) and uses that. If detection fails or the browser isn't supported, it falls back to Chrome.
+- **Headless** is recommended for unattended / server runs.
+- **`max_runs`** in the config is a safety cap to prevent accidental mass submissions.
+- The tool stops immediately on the first error and logs it — it will never silently fail in a loop.
+
+---
+
+## License
+
+Apache 2.0 — see [LICENSE](LICENSE).

gformbot-0.1.0/gformbot/__init__.py

@@ -0,0 +1,6 @@
+"""
+gformbot — A general-purpose Google Form auto-filler CLI.
+"""
+
+__version__ = "0.1.0"
+__author__ = "yogeshkrishna"

gformbot-0.1.0/gformbot/__main__.py

@@ -0,0 +1,3 @@
+"""Allow `python -m gformbot` invocation."""
+from gformbot.cli import main
+main()