#02-rename paperbot as paperscout

[henry0816191]

Summary by CodeRabbit

• Chores

  • Rebranded project identity from Paperbot to Paperscout across codebase, packaging, CI/CD, Docker, and deployment workflows.
  • Updated service names, database references, filesystem paths, and runtime entrypoints to use the new name.
  • Migrated package/module names and updated the test suite imports to align with the renamed project.

• Documentation

  • Updated README and deployment docs to reflect the Paperscout branding and deployment instructions.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 71d6e59d-10fa-4e74-87cc-b456361ee950

📥 Commits

Reviewing files that changed from the base of the PR and between f772eed and 59e9eec.

📒 Files selected for processing (3)

• .github/workflows/db-backup.yml
• deploy/SERVER_SETUP.md
• tests/conftest.py

🚧 Files skipped from review as they are similar to previous changes (3)

• .github/workflows/db-backup.yml
• tests/conftest.py
• deploy/SERVER_SETUP.md

---

📝 Walkthrough

Walkthrough

Renames the project from "paperbot" to "paperscout" across configuration, CI/CD, deployment, source, tests, and documentation — updating package identity, service names, DB connection, Docker/user/entrypoint, nginx routes, logging, and test imports.

Changes

Cohort / File(s)	Summary
Configuration & Packaging \.env.example, pyproject.toml, run, docker-compose.yml	Switch package/service name and DB connection from paperbot → paperscout; update coverage/packaging targets and compose service name.
CI / CD / Backups .github/workflows/ci.yml, .github/workflows/cd.yml, .github/workflows/db-backup.yml	Adjust coverage measurement, deploy SSH paths, docker-compose service, remote pg dump DB/name, and GCS backup object/bucket names to paperscout.
Container & Deployment Dockerfile, deploy/paperscout.conf, deploy/SERVER_SETUP.md	Change runtime user/ownership and ENTRYPOINT to paperscout; update nginx locations, server setup docs, DB provisioning names and deployment paths.
Source code (package rename) src/paperscout/__init__.py, src/paperscout/__main__.py, src/paperscout/config.py, src/paperscout/scout.py	Rebrand logging, module imports, version lookup, log filenames, and user-facing text to paperscout/“Scout”.
Tests tests/conftest.py, tests/test_health.py, tests/test_models.py, tests/test_monitor.py, tests/test_scout.py, tests/test_sources.py, tests/test_storage.py	Update all imports, patches, fixtures, and assertions to reference paperscout module paths and adjust test temp dir naming.
Documentation & Examples README.md	Replace project name, example commands/paths, Slack naming, GCS bucket references, and architecture/docs terminology from paperbot → paperscout.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Poem

🐰 I hopped through files both near and far,
Renamed the bot into a shining star.
From paperbot to Paperscout I bound,
New paths and logs now clearly found.
Cheer — the scout will watch and keep all sound!

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 8.70% which is insufficient. The required threshold is 80.00%.	Write docstrings for the functions missing them to satisfy the coverage threshold.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly and specifically describes the main change: renaming the project from 'paperbot' to 'paperscout' across all files and configurations.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests

---

_{Review rate limit: 2/5 reviews remaining, refill in 28 minutes and 52 seconds.}

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 4

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Inline comments:
In @.github/workflows/db-backup.yml:
- Around line 22-25: The script uses date twice producing potentially different
filenames; fix by generating a single timestamp once (assign to DUMP_TIMESTAMP
or reuse the DUMP variable) and use that variable in both the DUMP path
(DUMP="/tmp/paperscout-$DUMP_TIMESTAMP.dump" or set DUMP once) and the gsutil
target, so replace the second date invocation in the gsutil cp command with the
same timestamp variable used for the pg_dump file; update references to DUMP,
pg_dump and gsutil cp accordingly.

In `@deploy/SERVER_SETUP.md`:
- Around line 103-104: Update all occurrences of the GCS bucket name to the
canonical plural form used in README: replace any instance of
"gs://paperscout-backup" with "gs://paperscout-backups" in this document (e.g.,
the gsutil cp command and any other refs in deploy/SERVER_SETUP.md where
"paperscout-backup" appears) so the gsutil cp and related commands use the same
bucket name consistently.
- Around line 95-97: The restore command and the subsequent remove command use
different paths: "pg_restore -U paperscout -d paperscout --no-owner
paperscout.dump" vs "rm /tmp/paperscout.dump"; make the paths consistent by
either restoring from /tmp/paperscout.dump (update the pg_restore invocation to
use /tmp/paperscout.dump) or removing paperscout.dump (change rm to rm
paperscout.dump) so the file referenced in pg_restore and rm match.

In `@tests/conftest.py`:
- Line 203: Replace the hardcoded Path("/tmp/paperscout-test") used for data_dir
with a pytest-provided temporary directory (e.g. tmp_path or tmp_path_factory)
so each test run gets an isolated directory; update the fixture that sets
data_dir to use data_dir = tmp_path / "paperscout-test" (or create a unique dir
via tmp_path_factory.mktemp) and remove the fixed Path("/tmp/paperscout-test")
literal to avoid leaking state and satisfy Ruff S108.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

• Push a commit to this branch (recommended)
• Create a new PR with the fixes

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: aa7e33e0-e9e3-4ed2-9a3c-96d81994dba9

📥 Commits

Reviewing files that changed from the base of the PR and between d7aa22f and f772eed.

📒 Files selected for processing (28)

• .env.example
• .github/workflows/cd.yml
• .github/workflows/ci.yml
• .github/workflows/db-backup.yml
• Dockerfile
• README.md
• deploy/SERVER_SETUP.md
• deploy/paperscout.conf
• docker-compose.yml
• pyproject.toml
• run
• src/paperscout/__init__.py
• src/paperscout/__main__.py
• src/paperscout/config.py
• src/paperscout/db.py
• src/paperscout/health.py
• src/paperscout/models.py
• src/paperscout/monitor.py
• src/paperscout/scout.py
• src/paperscout/sources.py
• src/paperscout/storage.py
• tests/conftest.py
• tests/test_health.py
• tests/test_models.py
• tests/test_monitor.py
• tests/test_scout.py
• tests/test_sources.py
• tests/test_storage.py