withfeedback 0.1.0__tar.gz

withfeedback-0.1.0/.gitignore

@@ -0,0 +1,304 @@
+local_password.txt
+AGENTS-local.md
+dev.sh
+/media/*
+### VisualStudioCode template
+.vscode/*
+
+
+# Local History for Visual Studio Code
+.history/
+
+# Built Visual Studio Code Extensions
+*.vsix
+
+### JetBrains template
+# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider
+# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
+.idea/*
+
+# Gradle and Maven with auto-import
+# When using Gradle or Maven with auto-import, you should exclude module files,
+# since they will be recreated, and may cause churn.  Uncomment if using
+# auto-import.
+# .idea/artifacts
+# .idea/compiler.xml
+# .idea/jarRepositories.xml
+# .idea/modules.xml
+# .idea/*.iml
+# .idea/modules
+# *.iml
+# *.ipr
+
+# CMake
+cmake-build-*/
+
+# Mongo Explorer plugin
+.idea/**/mongoSettings.xml
+
+# File-based project format
+*.iws
+
+# IntelliJ
+out/
+
+# mpeltonen/sbt-idea plugin
+.idea_modules/
+
+# JIRA plugin
+atlassian-ide-plugin.xml
+
+# Cursive Clojure plugin
+.idea/replstate.xml
+
+# SonarLint plugin
+.idea/sonarlint/
+
+# Crashlytics plugin (for Android Studio and IntelliJ)
+com_crashlytics_export_strings.xml
+crashlytics.properties
+crashlytics-build.properties
+fabric.properties
+
+# Editor-based Rest Client
+.idea/httpRequests
+
+# Android studio 3.1+ serialized cache file
+.idea/caches/build_file_checksums.ser
+
+### Linux template
+*~
+
+# temporary files which can be created if a process still has a handle open of a deleted file
+.fuse_hidden*
+
+# KDE directory preferences
+.directory
+
+# Linux trash folder which might appear on any partition or disk
+.Trash-*
+
+# .nfs files are created when an open file is removed but is still being accessed
+.nfs*
+
+### Windows template
+# Windows thumbnail cache files
+Thumbs.db
+Thumbs.db:encryptable
+ehthumbs.db
+ehthumbs_vista.db
+
+# Dump file
+*.stackdump
+
+# Folder config file
+[Dd]esktop.ini
+
+# Recycle Bin used on file shares
+$RECYCLE.BIN/
+
+# Windows Installer files
+*.cab
+*.msi
+*.msix
+*.msm
+*.msp
+
+# Windows shortcuts
+*.lnk
+
+### macOS template
+# General
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+### Python template
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$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
+
+# 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
+
+# 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/#use-with-ide
+.pdm.toml
+
+# 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
+.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/
+
+/env/
+/tailwindcss
+
+node_modules/
+/staticfiles/*

withfeedback-0.1.0/PKG-INFO

@@ -0,0 +1,175 @@
+Metadata-Version: 2.5
+Name: withfeedback
+Version: 0.1.0
+Summary: Command-line client for withfeedback.com — testimonials, feedback moderation, imports, widgets, and NPS
+Project-URL: Homepage, https://withfeedback.com
+Project-URL: Documentation, https://withfeedback.com/api/docs/
+License: MIT
+Keywords: cli,feedback,testimonials,withfeedback
+Requires-Python: >=3.10
+Requires-Dist: click>=8.1
+Requires-Dist: httpx>=0.27
+Requires-Dist: keyring>=24
+Description-Content-Type: text/markdown
+
+# withfeedback CLI
+
+Command-line client for [withfeedback.com](https://withfeedback.com):
+testimonials, feedback moderation, CSV imports, surveys, NPS, widgets, and
+quota usage — from your terminal or CI.
+
+## Install
+
+```bash
+pip install withfeedback
+# or run without installing:
+uvx withfeedback --help
+```
+
+The console command is `withfeedback`.
+
+## Quick start with a personal access token (PAT)
+
+Good for CI and quick scripting:
+
+1. Log in at your withfeedback.com instance and open **Account → API Tokens**
+   (`/accounts/tokens/`).
+2. Create a token with the scopes you need (see the table below).
+3. Either export it per-shell:
+
+   ```bash
+   export WITHFEEDBACK_TOKEN=spd_abc123...
+   withfeedback testimonials list --team <TEAM_ID> --project <PROJECT_ID>
+   ```
+
+   or persist it in the OS keychain:
+
+   ```bash
+   withfeedback login --token spd_abc123...
+   ```
+
+API access requires a plan that includes the API/CLI/MCP feature (Pro and
+above).
+
+## Login via OAuth2 device flow (interactive)
+
+```bash
+withfeedback login
+```
+
+No flags needed against withfeedback.com — the CLI defaults to the official
+public client id `7yQMsnY2Is2f5tCuwwgItoQu3fRkEX2wnzIRj0Vh` (public by
+design — device-flow clients carry no secret). For a self-hosted instance
+pass your own client:
+
+```bash
+withfeedback login --client-id <CLIENT_ID>       # or WITHFEEDBACK_CLIENT_ID
+```
+
+What happens:
+
+1. The CLI calls `POST /o/device-authorization/` and prints a verification
+   URL plus a short code (it also tries to open your browser).
+2. You open the URL, enter the code, and approve the requested scopes.
+3. The CLI polls `POST /o/token/` until you approve, then stores the access
+   and refresh tokens in the **OS keychain** via `keyring` (macOS Keychain,
+   Windows Credential Locker, Secret Service/KWallet on Linux) — never in a
+   plaintext file.
+
+When an access token expires, the CLI transparently refreshes it. Refresh
+tokens rotate on every use; the rotated token replaces the stored one.
+(Stored PATs are never "refreshed" — if a PAT is rejected, the CLI tells you
+to create a new one and run `withfeedback login --token` again.)
+
+```bash
+withfeedback logout   # remove stored tokens from the keychain
+```
+
+Token resolution precedence for every command:
+`--token` flag > `WITHFEEDBACK_TOKEN` env var > OS keychain.
+
+## Commands
+
+```bash
+withfeedback login [--client-id <ID> | --token <PAT>]
+withfeedback logout
+
+withfeedback testimonials list    --team <ID> --project <ID> [--status pending|approved|rejected|spam] [--rating N] [--q text] [--json]
+withfeedback testimonials approve <SUBMISSION_ID> --team <ID> [--json]
+withfeedback testimonials reject  <SUBMISSION_ID> --team <ID> [--json]
+withfeedback testimonials create  --team <ID> --project <ID> --text "..." [--rating N] [--name ..] [--email ..] [--title ..] [--company ..] [--consent] [--tag t]... [--json]
+
+withfeedback import csv FILE --team <ID> --project <ID> --text-col COL [--rating-col COL] [--name-col COL] [--email-col COL] [--consent] [--json]
+
+withfeedback surveys list  --team <ID> --project <ID> [--json]
+withfeedback nps summary   --team <ID> --project <ID> [--json]
+withfeedback widgets list  --team <ID> --project <ID> [--json]
+withfeedback usage         --team <ID> [--json]
+```
+
+Human output is plain text tables. Pass `--json` for machine-readable output
+(raw API responses) — errors still go to stderr.
+
+### CSV import
+
+`withfeedback import csv` validates the file locally (header columns, row
+count), builds the column mapping from your `--*-col` options, and uploads
+the file to the server's multipart import endpoint. Rows are processed
+asynchronously and land as **pending** submissions; the command prints the
+batch id and a status URL to poll.
+
+```bash
+withfeedback import csv reviews.csv \
+  --team <TEAM_ID> --project <PROJECT_ID> \
+  --text-col "Testimonial" --rating-col "Stars" \
+  --name-col "Author" --email-col "Email" --consent
+```
+
+Pass `--consent` only when display consent was actually collected for these
+rows.
+
+## Required scopes per command
+
+| Command | Required scope |
+|---|---|
+| `testimonials list` | `read:feedback` (or `read:testimonials`) |
+| `testimonials approve` / `reject` | `moderate:submissions` (`write:*` cannot moderate) |
+| `testimonials create` | `write:testimonials` (or `write:feedback`) |
+| `import csv` | `write:feedback` |
+| `surveys list`, `nps summary` | `read:surveys` |
+| `widgets list` | `read:widgets` |
+| `usage` | `read:feedback` |
+
+## Exit codes
+
+| Code | Meaning |
+|---|---|
+| 0 | Success |
+| 1 | General / unknown error |
+| 2 | Usage / config error (bad flags, unreadable CSV, missing column) |
+| 3 | Auth error (not logged in, invalid or expired token) |
+| 4 | Forbidden or payment required (missing scope/role, plan without API access, quota exceeded, billing blocked) |
+| 5 | Not found (unknown team/project/object or no access) |
+| 6 | Validation error or invalid state transition |
+| 7 | Network error (server unreachable) |
+
+On API errors the API's error detail is printed to stderr.
+
+## Environment variables
+
+| Variable | Default | Purpose |
+|---|---|---|
+| `WITHFEEDBACK_API_URL` | `https://withfeedback.com` | API base URL (self-hosted/staging override) |
+| `WITHFEEDBACK_TOKEN` | — | PAT (beats the keychain, loses to `--token`) |
+| `WITHFEEDBACK_CLIENT_ID` | official public client id | Client id for `login` (override for self-hosted) |
+| `WITHFEEDBACK_SCOPES` | all CLI scopes | Scopes requested during device-flow login |
+
+On the first request of a run the CLI checks `GET /.well-known/speedpy.json`
+once and warns (never fails) when the manifest is unreachable or the API is
+older than the minimum this client expects.
+
+## Development
+
+```bash
+uv run --with pytest --with httpx --with click --with keyring pytest packages/withfeedback-cli/
+```

withfeedback-0.1.0/README.md

@@ -0,0 +1,161 @@
+# withfeedback CLI
+
+Command-line client for [withfeedback.com](https://withfeedback.com):
+testimonials, feedback moderation, CSV imports, surveys, NPS, widgets, and
+quota usage — from your terminal or CI.
+
+## Install
+
+```bash
+pip install withfeedback
+# or run without installing:
+uvx withfeedback --help
+```
+
+The console command is `withfeedback`.
+
+## Quick start with a personal access token (PAT)
+
+Good for CI and quick scripting:
+
+1. Log in at your withfeedback.com instance and open **Account → API Tokens**
+   (`/accounts/tokens/`).
+2. Create a token with the scopes you need (see the table below).
+3. Either export it per-shell:
+
+   ```bash
+   export WITHFEEDBACK_TOKEN=spd_abc123...
+   withfeedback testimonials list --team <TEAM_ID> --project <PROJECT_ID>
+   ```
+
+   or persist it in the OS keychain:
+
+   ```bash
+   withfeedback login --token spd_abc123...
+   ```
+
+API access requires a plan that includes the API/CLI/MCP feature (Pro and
+above).
+
+## Login via OAuth2 device flow (interactive)
+
+```bash
+withfeedback login
+```
+
+No flags needed against withfeedback.com — the CLI defaults to the official
+public client id `7yQMsnY2Is2f5tCuwwgItoQu3fRkEX2wnzIRj0Vh` (public by
+design — device-flow clients carry no secret). For a self-hosted instance
+pass your own client:
+
+```bash
+withfeedback login --client-id <CLIENT_ID>       # or WITHFEEDBACK_CLIENT_ID
+```
+
+What happens:
+
+1. The CLI calls `POST /o/device-authorization/` and prints a verification
+   URL plus a short code (it also tries to open your browser).
+2. You open the URL, enter the code, and approve the requested scopes.
+3. The CLI polls `POST /o/token/` until you approve, then stores the access
+   and refresh tokens in the **OS keychain** via `keyring` (macOS Keychain,
+   Windows Credential Locker, Secret Service/KWallet on Linux) — never in a
+   plaintext file.
+
+When an access token expires, the CLI transparently refreshes it. Refresh
+tokens rotate on every use; the rotated token replaces the stored one.
+(Stored PATs are never "refreshed" — if a PAT is rejected, the CLI tells you
+to create a new one and run `withfeedback login --token` again.)
+
+```bash
+withfeedback logout   # remove stored tokens from the keychain
+```
+
+Token resolution precedence for every command:
+`--token` flag > `WITHFEEDBACK_TOKEN` env var > OS keychain.
+
+## Commands
+
+```bash
+withfeedback login [--client-id <ID> | --token <PAT>]
+withfeedback logout
+
+withfeedback testimonials list    --team <ID> --project <ID> [--status pending|approved|rejected|spam] [--rating N] [--q text] [--json]
+withfeedback testimonials approve <SUBMISSION_ID> --team <ID> [--json]
+withfeedback testimonials reject  <SUBMISSION_ID> --team <ID> [--json]
+withfeedback testimonials create  --team <ID> --project <ID> --text "..." [--rating N] [--name ..] [--email ..] [--title ..] [--company ..] [--consent] [--tag t]... [--json]
+
+withfeedback import csv FILE --team <ID> --project <ID> --text-col COL [--rating-col COL] [--name-col COL] [--email-col COL] [--consent] [--json]
+
+withfeedback surveys list  --team <ID> --project <ID> [--json]
+withfeedback nps summary   --team <ID> --project <ID> [--json]
+withfeedback widgets list  --team <ID> --project <ID> [--json]
+withfeedback usage         --team <ID> [--json]
+```
+
+Human output is plain text tables. Pass `--json` for machine-readable output
+(raw API responses) — errors still go to stderr.
+
+### CSV import
+
+`withfeedback import csv` validates the file locally (header columns, row
+count), builds the column mapping from your `--*-col` options, and uploads
+the file to the server's multipart import endpoint. Rows are processed
+asynchronously and land as **pending** submissions; the command prints the
+batch id and a status URL to poll.
+
+```bash
+withfeedback import csv reviews.csv \
+  --team <TEAM_ID> --project <PROJECT_ID> \
+  --text-col "Testimonial" --rating-col "Stars" \
+  --name-col "Author" --email-col "Email" --consent
+```
+
+Pass `--consent` only when display consent was actually collected for these
+rows.
+
+## Required scopes per command
+
+| Command | Required scope |
+|---|---|
+| `testimonials list` | `read:feedback` (or `read:testimonials`) |
+| `testimonials approve` / `reject` | `moderate:submissions` (`write:*` cannot moderate) |
+| `testimonials create` | `write:testimonials` (or `write:feedback`) |
+| `import csv` | `write:feedback` |
+| `surveys list`, `nps summary` | `read:surveys` |
+| `widgets list` | `read:widgets` |
+| `usage` | `read:feedback` |
+
+## Exit codes
+
+| Code | Meaning |
+|---|---|
+| 0 | Success |
+| 1 | General / unknown error |
+| 2 | Usage / config error (bad flags, unreadable CSV, missing column) |
+| 3 | Auth error (not logged in, invalid or expired token) |
+| 4 | Forbidden or payment required (missing scope/role, plan without API access, quota exceeded, billing blocked) |
+| 5 | Not found (unknown team/project/object or no access) |
+| 6 | Validation error or invalid state transition |
+| 7 | Network error (server unreachable) |
+
+On API errors the API's error detail is printed to stderr.
+
+## Environment variables
+
+| Variable | Default | Purpose |
+|---|---|---|
+| `WITHFEEDBACK_API_URL` | `https://withfeedback.com` | API base URL (self-hosted/staging override) |
+| `WITHFEEDBACK_TOKEN` | — | PAT (beats the keychain, loses to `--token`) |
+| `WITHFEEDBACK_CLIENT_ID` | official public client id | Client id for `login` (override for self-hosted) |
+| `WITHFEEDBACK_SCOPES` | all CLI scopes | Scopes requested during device-flow login |
+
+On the first request of a run the CLI checks `GET /.well-known/speedpy.json`
+once and warns (never fails) when the manifest is unreachable or the API is
+older than the minimum this client expects.
+
+## Development
+
+```bash
+uv run --with pytest --with httpx --with click --with keyring pytest packages/withfeedback-cli/
+```

withfeedback-0.1.0/pyproject.toml

@@ -0,0 +1,27 @@
+[project]
+name = "withfeedback"
+version = "0.1.0"
+description = "Command-line client for withfeedback.com — testimonials, feedback moderation, imports, widgets, and NPS"
+readme = "README.md"
+requires-python = ">=3.10"
+license = { text = "MIT" }
+keywords = ["cli", "testimonials", "feedback", "withfeedback"]
+dependencies = [
+    "click>=8.1",
+    "httpx>=0.27",
+    "keyring>=24",
+]
+
+[project.urls]
+Homepage = "https://withfeedback.com"
+Documentation = "https://withfeedback.com/api/docs/"
+
+[project.scripts]
+withfeedback = "withfeedback_cli.main:cli"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/withfeedback_cli"]

withfeedback-0.1.0/src/withfeedback_cli/__init__.py

@@ -0,0 +1,3 @@
+"""withfeedback.com CLI package."""
+
+__version__ = "0.1.0"