mvote 0.1.0__tar.gz

mvote-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+                                 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, whether in Source or
+      Object form, 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 modifications
+      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 any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to 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 otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated 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 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 a Contribution incorporated within the Work constitutes direct
+      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, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, 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 copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this 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 redistributing 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 consequential 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 any and 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 act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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.
+

mvote-0.1.0/NOTICE

@@ -0,0 +1,14 @@
+mVote
+Copyright 2026 The Johns Hopkins University
+
+Developed by Valentín Quiroz de la Sierra and Marissa Ledesma for MalverdeSoftware.
+
+This work was supported by the National Institute on Drug Abuse of the
+National Institutes of Health under Award Number K99DA066943. The content is
+solely the responsibility of the authors and does not necessarily represent
+the official views of the National Institutes of Health.
+
+Cite as: de la Sierra, V. Q., & Ledesma, M. (2026). mVote
+[Computer software]. MalverdeSoftware. https://github.com/MalverdeSoftware/mvote
+
+This product includes third-party software; see THIRD_PARTY_NOTICES.md.

mvote-0.1.0/PKG-INFO

@@ -0,0 +1,76 @@
+Metadata-Version: 2.4
+Name: mvote
+Version: 0.1.0
+Summary: CLI for creating and configuring mVote participatory sticky-note voting sessions
+Author: Valentín Quiroz de la Sierra, Marissa Ledesma
+License-Expression: Apache-2.0
+Keywords: cbpr,participatory-research,dot-voting,research-tools
+Classifier: Programming Language :: Python :: 3
+Classifier: Intended Audience :: Science/Research
+Classifier: Topic :: Scientific/Engineering
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: NOTICE
+Requires-Dist: qrcode[pil]>=7.4
+Requires-Dist: click>=8.1
+Requires-Dist: firebase-admin>=6.5
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Dynamic: license-file
+
+# mvote (command line tool)
+
+A Python command line tool that creates mVote voting sessions ("boards") from a CSV or JSON file of items.
+
+## Install for development
+
+```bash
+cd cli
+pip install -e ".[dev]"
+```
+
+## Usage
+
+```bash
+mvote create --config ../examples/chks_example.json --title "Week 3"
+```
+
+This prints the board definition as JSON, or writes it to a file with `--out`. It doesn't touch any backend.
+
+### Publish a session to Firebase
+
+Add `--publish` to also write the board to Firestore and print a link and QR code you can share:
+
+```bash
+mvote create --config ../examples/chks_example.json --title "Week 3" --publish
+```
+
+Publishing sets every vote count to zero, so the tool won't publish over a board that already exists. Choose another `--board-id`, or add `--overwrite` if you mean to replace the board and start its counts again.
+
+This needs a Firebase project with **Firestore** turned on. Sign the tool in with a service account key. In the Firebase console, go to Project settings, then Service accounts, then Generate new private key. Then set `GOOGLE_APPLICATION_CREDENTIALS` to the downloaded JSON file. **Never commit this file to the repo.**
+
+```bash
+export GOOGLE_APPLICATION_CREDENTIALS=/path/to/serviceAccountKey.json
+```
+
+The link uses a placeholder domain until you tell the tool where the web app lives. Pass `--base-url` or set `MVOTE_WEBAPP_URL`. Use `--qr-out path.png` to save the QR code as an image instead of printing it.
+
+After participants have voted in the web app, pull the results:
+
+```bash
+mvote results --board-id <id> --out results.csv
+```
+
+## Tests
+
+```bash
+pytest
+```
+
+## Releases
+
+Releases follow [SPEC-distribution](https://github.com/MalverdeSoftware/malverdesoftware/blob/main/docs/specs/SPEC-distribution.md). Until the public flip, `.github/workflows/cli-release.yml` is a dry run. It builds the sdist and wheel, runs `twine check --strict` and `scripts/check-cli-release.py`, installs the wheel, and keeps the files as a workflow artifact. Nothing goes to PyPI.
+
+`cli/LICENSE` and `cli/NOTICE` are copies of the root files, so that both the wheel and installs from GitHub include them. After you edit either root file, run `python scripts/check-cli-release.py --fix`; the check fails while the copies differ. Release tags take the form `v<version>` and must match `version` in `pyproject.toml`.

mvote-0.1.0/README.md

@@ -0,0 +1,54 @@
+# mvote (command line tool)
+
+A Python command line tool that creates mVote voting sessions ("boards") from a CSV or JSON file of items.
+
+## Install for development
+
+```bash
+cd cli
+pip install -e ".[dev]"
+```
+
+## Usage
+
+```bash
+mvote create --config ../examples/chks_example.json --title "Week 3"
+```
+
+This prints the board definition as JSON, or writes it to a file with `--out`. It doesn't touch any backend.
+
+### Publish a session to Firebase
+
+Add `--publish` to also write the board to Firestore and print a link and QR code you can share:
+
+```bash
+mvote create --config ../examples/chks_example.json --title "Week 3" --publish
+```
+
+Publishing sets every vote count to zero, so the tool won't publish over a board that already exists. Choose another `--board-id`, or add `--overwrite` if you mean to replace the board and start its counts again.
+
+This needs a Firebase project with **Firestore** turned on. Sign the tool in with a service account key. In the Firebase console, go to Project settings, then Service accounts, then Generate new private key. Then set `GOOGLE_APPLICATION_CREDENTIALS` to the downloaded JSON file. **Never commit this file to the repo.**
+
+```bash
+export GOOGLE_APPLICATION_CREDENTIALS=/path/to/serviceAccountKey.json
+```
+
+The link uses a placeholder domain until you tell the tool where the web app lives. Pass `--base-url` or set `MVOTE_WEBAPP_URL`. Use `--qr-out path.png` to save the QR code as an image instead of printing it.
+
+After participants have voted in the web app, pull the results:
+
+```bash
+mvote results --board-id <id> --out results.csv
+```
+
+## Tests
+
+```bash
+pytest
+```
+
+## Releases
+
+Releases follow [SPEC-distribution](https://github.com/MalverdeSoftware/malverdesoftware/blob/main/docs/specs/SPEC-distribution.md). Until the public flip, `.github/workflows/cli-release.yml` is a dry run. It builds the sdist and wheel, runs `twine check --strict` and `scripts/check-cli-release.py`, installs the wheel, and keeps the files as a workflow artifact. Nothing goes to PyPI.
+
+`cli/LICENSE` and `cli/NOTICE` are copies of the root files, so that both the wheel and installs from GitHub include them. After you edit either root file, run `python scripts/check-cli-release.py --fix`; the check fails while the copies differ. Release tags take the form `v<version>` and must match `version` in `pyproject.toml`.

mvote-0.1.0/mvote/__init__.py

@@ -0,0 +1,3 @@
+"""mVote: session/board creation for participatory sticky-note voting."""
+
+__version__ = "0.1.0"

mvote-0.1.0/mvote/board.py

@@ -0,0 +1,63 @@
+"""Create and export mVote voting sessions ("boards").
+
+This module does not depend on any backend. :func:`create_board` returns a
+:class:`Board`, and a backend-specific writer (``firebase_store``) saves it.
+Keeping this backend-agnostic is what lets someone deploy mVote without
+being locked into Firebase specifically.
+"""
+from __future__ import annotations
+
+import uuid
+from dataclasses import asdict, dataclass, field
+from datetime import datetime, timezone
+from pathlib import Path
+from typing import Any
+
+from .config import Item, load_items
+
+
+@dataclass
+class Board:
+    board_id: str
+    title: str
+    items: list[Item]
+    created_at: str
+    metadata: dict[str, Any] = field(default_factory=dict)
+
+    def to_dict(self) -> dict:
+        return asdict(self)
+
+
+def create_board(config_path: str | Path, title: str, board_id: str | None = None) -> Board:
+    """Build a new :class:`Board` from an item config file.
+
+    Does not persist anything — callers (CLI, backend adapter) are
+    responsible for writing the board to a store and generating the
+    link/QR code from ``board_id``.
+    """
+    items = load_items(config_path)
+    return Board(
+        board_id=board_id or uuid.uuid4().hex[:8],
+        title=title,
+        items=items,
+        created_at=datetime.now(timezone.utc).isoformat(),
+    )
+
+
+def export_results(board: Board, vote_counts: dict[str, int]) -> list[dict]:
+    """Produce a tidy, analysis-ready export of vote results.
+
+    Returns one row per item: ``board_id``, ``board_title``, ``item_id``,
+    ``label``, ``vote_count`` — the structured-data export that is mVote's
+    core differentiator versus workshop-oriented dot-voting tools.
+    """
+    return [
+        {
+            "board_id": board.board_id,
+            "board_title": board.title,
+            "item_id": item.id,
+            "label": item.label,
+            "vote_count": vote_counts.get(item.id, 0),
+        }
+        for item in board.items
+    ]

mvote-0.1.0/mvote/cli.py

@@ -0,0 +1,125 @@
+"""Command-line interface for creating mVote voting sessions."""
+from __future__ import annotations
+
+import csv
+import json
+import os
+import sys
+from pathlib import Path
+
+import click
+
+from . import firebase_store
+from .board import create_board
+from .config import ConfigError
+
+DEFAULT_BASE_URL_ENV = "MVOTE_WEBAPP_URL"
+PLACEHOLDER_BASE_URL = "https://mvote.example/vote"
+RESULT_FIELDS = ["board_id", "board_title", "item_id", "label", "vote_count"]
+
+
+@click.group()
+@click.version_option()
+def main():
+    """mVote: create participatory sticky-note voting sessions."""
+
+
+@main.command("create")
+@click.option("--config", "config_path", required=True, type=click.Path(exists=True),
+              help="Path to a CSV or JSON item config file.")
+@click.option("--title", required=True, help="Title for this session (e.g. 'Week 3').")
+@click.option("--board-id", default=None, help="Optional fixed board id; random if omitted.")
+@click.option("--out", "out_path", default=None, type=click.Path(),
+              help="Write the board definition (JSON) to this path instead of stdout.")
+@click.option("--publish/--no-publish", default=False,
+              help="Also write the board to Firebase and print a shareable link + QR code.")
+@click.option("--overwrite", is_flag=True, default=False,
+              help="With --publish, replace a board that already has this id. Its vote counts "
+                   "return to zero; dots participants already spent stay spent.")
+@click.option("--base-url", default=None,
+              help=f"Webapp base URL for the shareable link (or set {DEFAULT_BASE_URL_ENV}). "
+                   "Only used with --publish.")
+@click.option("--qr-out", "qr_out_path", default=None, type=click.Path(),
+              help="Save the shareable link's QR code as a PNG to this path (only with --publish; "
+                   "prints an ASCII QR code to the terminal if omitted).")
+def create(config_path: str, title: str, board_id: str | None, out_path: str | None,
+           publish: bool, overwrite: bool, base_url: str | None, qr_out_path: str | None):
+    """Create a new board from an item config file.
+
+    With --publish, also writes the board to Firestore (see cli/README.md
+    for the required GOOGLE_APPLICATION_CREDENTIALS setup) and prints a
+    shareable participant link and QR code.
+    """
+    try:
+        board = create_board(config_path, title=title, board_id=board_id)
+    except ConfigError as e:
+        click.echo(f"Config error: {e}", err=True)
+        sys.exit(1)
+
+    payload = board.to_dict()
+    text = json.dumps(payload, indent=2, default=str)
+
+    if out_path:
+        Path(out_path).write_text(text, encoding="utf-8")
+        click.echo(f"Board '{board.board_id}' written to {out_path}")
+    else:
+        click.echo(text)
+
+    if publish:
+        try:
+            firebase_store.save_board(board, overwrite=overwrite)
+        except firebase_store.BoardExistsError as e:
+            click.echo(str(e), err=True)
+            sys.exit(1)
+        click.echo(f"Board '{board.board_id}' published to Firestore.")
+
+        resolved_base_url = base_url or os.environ.get(DEFAULT_BASE_URL_ENV)
+        if not resolved_base_url:
+            resolved_base_url = PLACEHOLDER_BASE_URL
+            click.echo(
+                f"Note: no webapp URL configured (--base-url or {DEFAULT_BASE_URL_ENV}); "
+                "using a placeholder until the webapp is deployed.",
+                err=True,
+            )
+        link = f"{resolved_base_url.rstrip('/')}/{board.board_id}"
+        click.echo(f"Participant link: {link}")
+
+        import qrcode
+
+        if qr_out_path:
+            qrcode.make(link).save(qr_out_path)
+            click.echo(f"QR code written to {qr_out_path}")
+        else:
+            qr = qrcode.QRCode()
+            qr.add_data(link)
+            qr.print_ascii()
+
+
+@main.command("results")
+@click.option("--board-id", required=True, help="Id of a board previously created with --publish.")
+@click.option("--out", "out_path", default=None, type=click.Path(),
+              help="Write results as CSV to this path instead of stdout.")
+def results(board_id: str, out_path: str | None):
+    """Fetch live vote counts for a published board and export tidy results."""
+    try:
+        rows = firebase_store.export_board_results(board_id)
+    except ValueError as e:
+        click.echo(str(e), err=True)
+        sys.exit(1)
+
+    if out_path:
+        with open(out_path, "w", newline="", encoding="utf-8") as f:
+            _write_results(f, rows)
+        click.echo(f"Results for board '{board_id}' written to {out_path}")
+    else:
+        _write_results(sys.stdout, rows)
+
+
+def _write_results(stream, rows: list[dict]) -> None:
+    writer = csv.DictWriter(stream, fieldnames=RESULT_FIELDS)
+    writer.writeheader()
+    writer.writerows(rows)
+
+
+if __name__ == "__main__":
+    main()

mvote-0.1.0/mvote/config.py

@@ -0,0 +1,105 @@
+"""Load and validate item configs (CSV or JSON) for a mVote session.
+
+An item config defines the sticky notes participants will vote on. Each item
+needs at minimum an ``id`` and a ``label``; a ``description`` is optional.
+
+JSON format::
+
+    [
+      {"id": "var_001", "label": "Depressive symptoms", "description": "..."},
+      {"id": "var_002", "label": "Sleep quality"}
+    ]
+
+CSV format (header row required)::
+
+    id,label,description
+    var_001,Depressive symptoms,...
+    var_002,Sleep quality,
+"""
+from __future__ import annotations
+
+import csv
+import json
+from dataclasses import dataclass
+from pathlib import Path
+
+
+REQUIRED_FIELDS = ("id", "label")
+
+
+class ConfigError(ValueError):
+    """Raised when an item config file is missing required fields or is malformed."""
+
+
+@dataclass(frozen=True)
+class Item:
+    id: str
+    label: str
+    description: str = ""
+
+
+def load_items(path: str | Path) -> list[Item]:
+    """Load a list of :class:`Item` from a CSV or JSON file.
+
+    Raises:
+        ConfigError: if the file is malformed, has duplicate ids, or is
+            missing required fields.
+        FileNotFoundError: if ``path`` does not exist.
+    """
+    path = Path(path)
+    if not path.exists():
+        raise FileNotFoundError(f"Config file not found: {path}")
+
+    if path.suffix.lower() == ".json":
+        raw_items = _load_json(path)
+    elif path.suffix.lower() == ".csv":
+        raw_items = _load_csv(path)
+    else:
+        raise ConfigError(
+            f"Unsupported config file type '{path.suffix}'. Use .csv or .json."
+        )
+
+    items = []
+    seen_ids = set()
+    for i, raw in enumerate(raw_items):
+        if not isinstance(raw, dict):
+            raise ConfigError(f"Item at index {i} must be an object with id and label.")
+        missing = [f for f in REQUIRED_FIELDS if not raw.get(f)]
+        if missing:
+            raise ConfigError(
+                f"Item at index {i} is missing required field(s): {missing}"
+            )
+        # Compared as text, the way ids are stored: 1 and "1" are the same id.
+        item_id = str(raw["id"])
+        if item_id in seen_ids:
+            raise ConfigError(f"Duplicate item id found: '{item_id}'")
+        seen_ids.add(item_id)
+        items.append(
+            Item(
+                id=item_id,
+                label=str(raw["label"]),
+                description=str(raw.get("description", "") or ""),
+            )
+        )
+
+    if not items:
+        raise ConfigError("Config file contains no items.")
+
+    return items
+
+
+def _load_json(path: Path) -> list[dict]:
+    with path.open("r", encoding="utf-8") as f:
+        try:
+            data = json.load(f)
+        except json.JSONDecodeError as e:
+            raise ConfigError(f"Config file is not valid JSON: {e}") from e
+    if not isinstance(data, list):
+        raise ConfigError("JSON config must be a list of item objects.")
+    return data
+
+
+def _load_csv(path: Path) -> list[dict]:
+    with path.open("r", encoding="utf-8", newline="") as f:
+        reader = csv.DictReader(f)
+        return list(reader)

mvote-0.1.0/mvote/firebase_store.py

@@ -0,0 +1,116 @@
+"""Firestore-backed persistence for mVote boards and votes.
+
+This is the one Firebase-specific module in the project — board.py stays
+backend-agnostic on purpose (see its docstring). Swapping to a different
+backend later means reimplementing the functions here, not touching board.py.
+
+Every function accepts an optional ``db`` (a Firestore client, or anything
+duck-typing its ``collection()``/``document()`` interface) so callers —
+tests included — can inject a fake instead of hitting real Firebase.
+"""
+from __future__ import annotations
+
+import os
+from typing import Any
+
+from .board import Board, export_results
+from .config import Item
+
+BOARDS_COLLECTION = "boards"
+VOTES_SUBCOLLECTION = "votes"
+
+
+def get_client() -> Any:
+    """Return a Firestore client, initializing the Firebase app if needed.
+
+    Credentials come from the ``GOOGLE_APPLICATION_CREDENTIALS`` environment
+    variable (a service-account JSON key path) via Firebase's standard
+    Application Default Credentials flow — see cli/README.md for setup.
+    """
+    import firebase_admin
+    from firebase_admin import credentials, firestore
+
+    if not firebase_admin._apps:
+        cred_path = os.environ.get("GOOGLE_APPLICATION_CREDENTIALS")
+        if cred_path:
+            firebase_admin.initialize_app(credentials.Certificate(cred_path))
+        else:
+            firebase_admin.initialize_app()
+    return firestore.client()
+
+
+class BoardExistsError(ValueError):
+    """Raised when publishing would replace a board that is already there."""
+
+
+def save_board(board: Board, db: Any = None, overwrite: bool = False) -> None:
+    """Write a board and its zero-initialized vote counts to Firestore.
+
+    Publishing sets every count to zero, so a board that already exists is
+    left alone unless ``overwrite`` is true.
+
+    Raises:
+        BoardExistsError: if the board exists and ``overwrite`` is false.
+    """
+    db = db or get_client()
+    board_ref = db.collection(BOARDS_COLLECTION).document(board.board_id)
+    if not overwrite and board_ref.get().exists:
+        raise BoardExistsError(
+            f"Board '{board.board_id}' already exists. Publishing again would reset its "
+            "votes to zero. Choose another --board-id, or pass --overwrite to replace it."
+        )
+    board_ref.set(
+        {
+            "title": board.title,
+            "created_at": board.created_at,
+            "metadata": board.metadata,
+            "items": [
+                {"id": item.id, "label": item.label, "description": item.description}
+                for item in board.items
+            ],
+        }
+    )
+    votes_ref = board_ref.collection(VOTES_SUBCOLLECTION)
+    for item in board.items:
+        votes_ref.document(item.id).set({"count": 0})
+
+
+def load_board(board_id: str, db: Any = None) -> Board:
+    """Fetch a previously-saved board definition from Firestore.
+
+    Raises:
+        ValueError: if no board with this id exists.
+    """
+    db = db or get_client()
+    snapshot = db.collection(BOARDS_COLLECTION).document(board_id).get()
+    if not snapshot.exists:
+        raise ValueError(f"Board '{board_id}' not found.")
+    data = snapshot.to_dict()
+    items = [
+        Item(id=i["id"], label=i["label"], description=i.get("description", ""))
+        for i in data["items"]
+    ]
+    return Board(
+        board_id=board_id,
+        title=data["title"],
+        items=items,
+        created_at=data["created_at"],
+        metadata=data.get("metadata", {}),
+    )
+
+
+def fetch_vote_counts(board_id: str, db: Any = None) -> dict[str, int]:
+    """Read current per-item vote counts for a board from Firestore."""
+    db = db or get_client()
+    votes_ref = db.collection(BOARDS_COLLECTION).document(board_id).collection(
+        VOTES_SUBCOLLECTION
+    )
+    return {doc.id: (doc.to_dict() or {}).get("count", 0) for doc in votes_ref.stream()}
+
+
+def export_board_results(board_id: str, db: Any = None) -> list[dict]:
+    """Load a board and its live vote counts, and produce the tidy export rows."""
+    db = db or get_client()
+    board = load_board(board_id, db=db)
+    vote_counts = fetch_vote_counts(board_id, db=db)
+    return export_results(board, vote_counts)

mvote-0.1.0/mvote.egg-info/PKG-INFO

@@ -0,0 +1,76 @@
+Metadata-Version: 2.4
+Name: mvote
+Version: 0.1.0
+Summary: CLI for creating and configuring mVote participatory sticky-note voting sessions
+Author: Valentín Quiroz de la Sierra, Marissa Ledesma
+License-Expression: Apache-2.0
+Keywords: cbpr,participatory-research,dot-voting,research-tools
+Classifier: Programming Language :: Python :: 3
+Classifier: Intended Audience :: Science/Research
+Classifier: Topic :: Scientific/Engineering
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: NOTICE
+Requires-Dist: qrcode[pil]>=7.4
+Requires-Dist: click>=8.1
+Requires-Dist: firebase-admin>=6.5
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Dynamic: license-file
+
+# mvote (command line tool)
+
+A Python command line tool that creates mVote voting sessions ("boards") from a CSV or JSON file of items.
+
+## Install for development
+
+```bash
+cd cli
+pip install -e ".[dev]"
+```
+
+## Usage
+
+```bash
+mvote create --config ../examples/chks_example.json --title "Week 3"
+```
+
+This prints the board definition as JSON, or writes it to a file with `--out`. It doesn't touch any backend.
+
+### Publish a session to Firebase
+
+Add `--publish` to also write the board to Firestore and print a link and QR code you can share:
+
+```bash
+mvote create --config ../examples/chks_example.json --title "Week 3" --publish
+```
+
+Publishing sets every vote count to zero, so the tool won't publish over a board that already exists. Choose another `--board-id`, or add `--overwrite` if you mean to replace the board and start its counts again.
+
+This needs a Firebase project with **Firestore** turned on. Sign the tool in with a service account key. In the Firebase console, go to Project settings, then Service accounts, then Generate new private key. Then set `GOOGLE_APPLICATION_CREDENTIALS` to the downloaded JSON file. **Never commit this file to the repo.**
+
+```bash
+export GOOGLE_APPLICATION_CREDENTIALS=/path/to/serviceAccountKey.json
+```
+
+The link uses a placeholder domain until you tell the tool where the web app lives. Pass `--base-url` or set `MVOTE_WEBAPP_URL`. Use `--qr-out path.png` to save the QR code as an image instead of printing it.
+
+After participants have voted in the web app, pull the results:
+
+```bash
+mvote results --board-id <id> --out results.csv
+```
+
+## Tests
+
+```bash
+pytest
+```
+
+## Releases
+
+Releases follow [SPEC-distribution](https://github.com/MalverdeSoftware/malverdesoftware/blob/main/docs/specs/SPEC-distribution.md). Until the public flip, `.github/workflows/cli-release.yml` is a dry run. It builds the sdist and wheel, runs `twine check --strict` and `scripts/check-cli-release.py`, installs the wheel, and keeps the files as a workflow artifact. Nothing goes to PyPI.
+
+`cli/LICENSE` and `cli/NOTICE` are copies of the root files, so that both the wheel and installs from GitHub include them. After you edit either root file, run `python scripts/check-cli-release.py --fix`; the check fails while the copies differ. Release tags take the form `v<version>` and must match `version` in `pyproject.toml`.

mvote-0.1.0/mvote.egg-info/SOURCES.txt

@@ -0,0 +1,19 @@
+LICENSE
+NOTICE
+README.md
+pyproject.toml
+mvote/__init__.py
+mvote/board.py
+mvote/cli.py
+mvote/config.py
+mvote/firebase_store.py
+mvote.egg-info/PKG-INFO
+mvote.egg-info/SOURCES.txt
+mvote.egg-info/dependency_links.txt
+mvote.egg-info/entry_points.txt
+mvote.egg-info/requires.txt
+mvote.egg-info/top_level.txt
+tests/test_board.py
+tests/test_cli.py
+tests/test_config.py
+tests/test_firebase_store.py

mvote-0.1.0/mvote.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

mvote-0.1.0/mvote.egg-info/entry_points.txt

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

mvote-0.1.0/mvote.egg-info/requires.txt

@@ -0,0 +1,7 @@
+qrcode[pil]>=7.4
+click>=8.1
+firebase-admin>=6.5
+
+[dev]
+pytest>=7.0
+pytest-cov

mvote-0.1.0/mvote.egg-info/top_level.txt

@@ -0,0 +1 @@
+mvote

mvote-0.1.0/pyproject.toml

@@ -0,0 +1,39 @@
+[build-system]
+requires = ["setuptools>=77"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "mvote"
+version = "0.1.0"
+description = "CLI for creating and configuring mVote participatory sticky-note voting sessions"
+readme = "README.md"
+license = "Apache-2.0"
+license-files = ["LICENSE", "NOTICE"]
+requires-python = ">=3.9"
+authors = [
+  { name = "Valentín Quiroz de la Sierra" },
+  { name = "Marissa Ledesma" },
+]
+keywords = ["cbpr", "participatory-research", "dot-voting", "research-tools"]
+classifiers = [
+  "Programming Language :: Python :: 3",
+  "Intended Audience :: Science/Research",
+  "Topic :: Scientific/Engineering",
+]
+dependencies = [
+  "qrcode[pil]>=7.4",
+  "click>=8.1",
+  "firebase-admin>=6.5",
+]
+
+[project.optional-dependencies]
+dev = [
+  "pytest>=7.0",
+  "pytest-cov",
+]
+
+[project.scripts]
+mvote = "mvote.cli:main"
+
+[tool.setuptools.packages.find]
+include = ["mvote*"]

mvote-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

mvote-0.1.0/tests/test_board.py

@@ -0,0 +1,38 @@
+import json
+
+from mvote.board import create_board, export_results
+
+
+def _write_config(tmp_path):
+    p = tmp_path / "items.json"
+    p.write_text(json.dumps([
+        {"id": "v1", "label": "Sleep quality"},
+        {"id": "v2", "label": "Mood"},
+    ]))
+    return p
+
+
+def test_create_board(tmp_path):
+    config = _write_config(tmp_path)
+    board = create_board(config, title="Test Session")
+    assert board.title == "Test Session"
+    assert len(board.items) == 2
+    assert board.board_id  # non-empty
+
+
+def test_create_board_fixed_id(tmp_path):
+    config = _write_config(tmp_path)
+    board = create_board(config, title="Test Session", board_id="fixed123")
+    assert board.board_id == "fixed123"
+
+
+def test_export_results(tmp_path):
+    config = _write_config(tmp_path)
+    board = create_board(config, title="Test Session", board_id="b1")
+    rows = export_results(board, vote_counts={"v1": 5})
+    assert rows == [
+        {"board_id": "b1", "board_title": "Test Session", "item_id": "v1",
+         "label": "Sleep quality", "vote_count": 5},
+        {"board_id": "b1", "board_title": "Test Session", "item_id": "v2",
+         "label": "Mood", "vote_count": 0},
+    ]

mvote-0.1.0/tests/test_cli.py

@@ -0,0 +1,111 @@
+import json
+
+from click.testing import CliRunner
+
+from mvote.cli import main
+
+
+def _write_config(tmp_path):
+    p = tmp_path / "items.json"
+    p.write_text(json.dumps([{"id": "v1", "label": "Sleep quality"}]))
+    return p
+
+
+def test_create_without_publish_does_not_touch_firebase(tmp_path, monkeypatch):
+    calls = []
+    monkeypatch.setattr(
+        "mvote.cli.firebase_store.save_board",
+        lambda board, db=None, overwrite=False: calls.append(board),
+    )
+
+    result = CliRunner().invoke(main, [
+        "create", "--config", str(_write_config(tmp_path)), "--title", "T",
+    ])
+
+    assert result.exit_code == 0
+    assert calls == []
+
+
+def test_create_with_publish_writes_board_and_prints_link(tmp_path, monkeypatch):
+    calls = []
+    monkeypatch.setattr(
+        "mvote.cli.firebase_store.save_board",
+        lambda board, db=None, overwrite=False: calls.append(board),
+    )
+    monkeypatch.delenv("MVOTE_WEBAPP_URL", raising=False)
+
+    result = CliRunner().invoke(main, [
+        "create", "--config", str(_write_config(tmp_path)), "--title", "T",
+        "--board-id", "b1", "--publish", "--base-url", "https://example.com/vote",
+    ])
+
+    assert result.exit_code == 0, result.output
+    assert len(calls) == 1
+    assert calls[0].board_id == "b1"
+    assert "Participant link: https://example.com/vote/b1" in result.output
+
+
+def test_create_with_publish_uses_placeholder_url_when_unset(tmp_path, monkeypatch):
+    monkeypatch.setattr("mvote.cli.firebase_store.save_board", lambda board, db=None, overwrite=False: None)
+    monkeypatch.delenv("MVOTE_WEBAPP_URL", raising=False)
+
+    result = CliRunner().invoke(main, [
+        "create", "--config", str(_write_config(tmp_path)), "--title", "T",
+        "--board-id", "b1", "--publish",
+    ])
+
+    assert result.exit_code == 0, result.output
+    assert "mvote.example/vote/b1" in result.output
+
+
+def test_create_with_publish_refuses_an_existing_board(tmp_path, monkeypatch):
+    from mvote.firebase_store import BoardExistsError
+
+    seen = []
+
+    def save(board, db=None, overwrite=False):
+        seen.append(overwrite)
+        if not overwrite:
+            raise BoardExistsError("Board 'b1' already exists.")
+
+    monkeypatch.setattr("mvote.cli.firebase_store.save_board", save)
+    args = ["create", "--config", str(_write_config(tmp_path)), "--title", "T",
+            "--board-id", "b1", "--publish", "--base-url", "https://example.com/vote"]
+
+    refused = CliRunner().invoke(main, args)
+    assert refused.exit_code == 1
+    assert "already exists" in refused.output
+    assert "Participant link" not in refused.output
+
+    replaced = CliRunner().invoke(main, args + ["--overwrite"])
+    assert replaced.exit_code == 0, replaced.output
+    assert seen == [False, True]
+
+
+def test_results_writes_csv(monkeypatch):
+    rows = [
+        {"board_id": "b1", "board_title": "T", "item_id": "v1",
+         "label": "Sleep quality", "vote_count": 4},
+    ]
+    monkeypatch.setattr(
+        "mvote.cli.firebase_store.export_board_results",
+        lambda board_id, db=None: rows,
+    )
+
+    result = CliRunner().invoke(main, ["results", "--board-id", "b1"])
+
+    assert result.exit_code == 0, result.output
+    assert "v1" in result.output
+    assert "4" in result.output
+
+
+def test_results_missing_board_exits_nonzero(monkeypatch):
+    def raise_not_found(board_id, db=None):
+        raise ValueError(f"Board '{board_id}' not found.")
+
+    monkeypatch.setattr("mvote.cli.firebase_store.export_board_results", raise_not_found)
+
+    result = CliRunner().invoke(main, ["results", "--board-id", "nope"])
+
+    assert result.exit_code == 1
+    assert "not found" in result.output

mvote-0.1.0/tests/test_config.py

@@ -0,0 +1,84 @@
+import json
+import pytest
+
+from mvote.config import ConfigError, load_items
+
+
+def test_load_json_items(tmp_path):
+    p = tmp_path / "items.json"
+    p.write_text(json.dumps([
+        {"id": "v1", "label": "Sleep quality"},
+        {"id": "v2", "label": "Mood", "description": "self-reported mood"},
+    ]))
+    items = load_items(p)
+    assert len(items) == 2
+    assert items[0].id == "v1"
+    assert items[1].description == "self-reported mood"
+
+
+def test_load_csv_items(tmp_path):
+    p = tmp_path / "items.csv"
+    p.write_text("id,label,description\nv1,Sleep quality,\nv2,Mood,self-reported mood\n")
+    items = load_items(p)
+    assert len(items) == 2
+    assert items[1].label == "Mood"
+
+
+def test_missing_required_field(tmp_path):
+    p = tmp_path / "items.json"
+    p.write_text(json.dumps([{"id": "v1"}]))
+    with pytest.raises(ConfigError):
+        load_items(p)
+
+
+def test_duplicate_ids(tmp_path):
+    p = tmp_path / "items.json"
+    p.write_text(json.dumps([
+        {"id": "v1", "label": "A"},
+        {"id": "v1", "label": "B"},
+    ]))
+    with pytest.raises(ConfigError):
+        load_items(p)
+
+
+def test_empty_config(tmp_path):
+    p = tmp_path / "items.json"
+    p.write_text(json.dumps([]))
+    with pytest.raises(ConfigError):
+        load_items(p)
+
+
+def test_unsupported_extension(tmp_path):
+    p = tmp_path / "items.txt"
+    p.write_text("not a config")
+    with pytest.raises(ConfigError):
+        load_items(p)
+
+
+def test_missing_file(tmp_path):
+    with pytest.raises(FileNotFoundError):
+        load_items(tmp_path / "does_not_exist.json")
+
+
+def test_ids_that_differ_only_by_type_are_duplicates(tmp_path):
+    p = tmp_path / "items.json"
+    p.write_text(json.dumps([
+        {"id": 1, "label": "A"},
+        {"id": "1", "label": "B"},
+    ]))
+    with pytest.raises(ConfigError, match="Duplicate"):
+        load_items(p)
+
+
+def test_item_that_is_not_an_object(tmp_path):
+    p = tmp_path / "items.json"
+    p.write_text(json.dumps(["Sleep quality", "Mood"]))
+    with pytest.raises(ConfigError, match="index 0"):
+        load_items(p)
+
+
+def test_invalid_json(tmp_path):
+    p = tmp_path / "items.json"
+    p.write_text("[{'id': 'v1'}")
+    with pytest.raises(ConfigError, match="not valid JSON"):
+        load_items(p)

mvote-0.1.0/tests/test_firebase_store.py

@@ -0,0 +1,139 @@
+import json
+
+import pytest
+
+from mvote import firebase_store
+from mvote.board import create_board
+
+
+class FakeSnapshot:
+    def __init__(self, doc_id, data):
+        self.id = doc_id
+        self._data = data
+
+    @property
+    def exists(self):
+        return self._data is not None
+
+    def to_dict(self):
+        return self._data
+
+
+class FakeDocumentRef:
+    def __init__(self, store, path):
+        self._store = store
+        self._path = path
+
+    def set(self, data):
+        self._store[self._path] = dict(data)
+
+    def get(self):
+        return FakeSnapshot(self._path[-1], self._store.get(self._path))
+
+    def collection(self, name):
+        return FakeCollectionRef(self._store, self._path + (name,))
+
+
+class FakeCollectionRef:
+    def __init__(self, store, path):
+        self._store = store
+        self._path = path
+
+    def document(self, doc_id):
+        return FakeDocumentRef(self._store, self._path + (doc_id,))
+
+    def stream(self):
+        depth = len(self._path) + 1
+        return [
+            FakeSnapshot(path[-1], data)
+            for path, data in self._store.items()
+            if len(path) == depth and path[: len(self._path)] == self._path
+        ]
+
+
+class FakeFirestoreClient:
+    """Minimal in-memory stand-in for a Firestore client, keyed by path tuples."""
+
+    def __init__(self):
+        self._store = {}
+
+    def collection(self, name):
+        return FakeCollectionRef(self._store, (name,))
+
+
+def _write_config(tmp_path):
+    p = tmp_path / "items.json"
+    p.write_text(json.dumps([
+        {"id": "v1", "label": "Sleep quality"},
+        {"id": "v2", "label": "Mood", "description": "Overall mood rating"},
+    ]))
+    return p
+
+
+def test_save_and_load_board_round_trips(tmp_path):
+    db = FakeFirestoreClient()
+    board = create_board(_write_config(tmp_path), title="Week 3", board_id="b1")
+
+    firebase_store.save_board(board, db=db)
+    loaded = firebase_store.load_board("b1", db=db)
+
+    assert loaded.board_id == board.board_id
+    assert loaded.title == board.title
+    assert loaded.created_at == board.created_at
+    assert loaded.items == board.items
+
+
+def test_save_board_initializes_zero_vote_counts(tmp_path):
+    db = FakeFirestoreClient()
+    board = create_board(_write_config(tmp_path), title="Week 3", board_id="b1")
+
+    firebase_store.save_board(board, db=db)
+
+    assert firebase_store.fetch_vote_counts("b1", db=db) == {"v1": 0, "v2": 0}
+
+
+def test_save_board_leaves_an_existing_board_and_its_votes_alone(tmp_path):
+    db = FakeFirestoreClient()
+    board = create_board(_write_config(tmp_path), title="T", board_id="b1")
+    firebase_store.save_board(board, db=db)
+    votes = db.collection("boards").document("b1").collection("votes")
+    votes.document(board.items[0].id).set({"count": 5})
+
+    with pytest.raises(firebase_store.BoardExistsError):
+        firebase_store.save_board(board, db=db)
+    assert firebase_store.fetch_vote_counts("b1", db=db)[board.items[0].id] == 5
+
+    firebase_store.save_board(board, db=db, overwrite=True)
+    assert firebase_store.fetch_vote_counts("b1", db=db)[board.items[0].id] == 0
+
+
+def test_fetch_vote_counts_reflects_updates(tmp_path):
+    db = FakeFirestoreClient()
+    board = create_board(_write_config(tmp_path), title="Week 3", board_id="b1")
+    firebase_store.save_board(board, db=db)
+
+    db.collection("boards").document("b1").collection("votes").document("v1").set({"count": 5})
+
+    assert firebase_store.fetch_vote_counts("b1", db=db) == {"v1": 5, "v2": 0}
+
+
+def test_load_board_missing_raises():
+    db = FakeFirestoreClient()
+    with pytest.raises(ValueError, match="not found"):
+        firebase_store.load_board("nope", db=db)
+
+
+def test_export_board_results(tmp_path):
+    db = FakeFirestoreClient()
+    board = create_board(_write_config(tmp_path), title="Week 3", board_id="b1")
+    firebase_store.save_board(board, db=db)
+    db.collection("boards").document("b1").collection("votes").document("v1").set({"count": 3})
+
+    rows = firebase_store.export_board_results("b1", db=db)
+
+    assert rows == [
+        {"board_id": "b1", "board_title": "Week 3", "item_id": "v1",
+         "label": "Sleep quality", "vote_count": 3},
+        {"board_id": "b1", "board_title": "Week 3", "item_id": "v2",
+         "label": "Mood", "vote_count": 0},
+    ]