Skip to content

updated arch#196

Merged
ryansurf merged 1 commit intomainfrom
feat-domain-name
Apr 10, 2026
Merged

updated arch#196
ryansurf merged 1 commit intomainfrom
feat-domain-name

Conversation

@ryansurf
Copy link
Copy Markdown
Owner

@ryansurf ryansurf commented Apr 10, 2026

General:

  • Have you followed the guidelines in our Contributing document?
  • Have you checked to ensure there aren't other open Pull Requests for the same update/change?

Code:

  1. Does your submission pass tests?
  2. Have you run the linter/formatter on your code locally before submission?
  3. Have you updated the documentation/README to reflect your changes, as applicable?
  4. Have you added an explanation of what your changes do?
  5. Have you written new tests for your changes, as applicable?

Summary by Sourcery

Update README to document additional usage options and clarify deployment architecture.

Documentation:

  • Document public API usage with a curl example and distinguish it from running the server locally.
  • Expand architecture table to include cloud infrastructure components such as AWS services, Cloudflare, and GoDaddy.

@sourcery-ai
Copy link
Copy Markdown
Contributor

sourcery-ai bot commented Apr 10, 2026

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Updates the README to clarify the different ways to use cli-surf (CLI, public API, local server) and documents the cloud architecture components used by the project.

File-Level Changes

Change Details Files
Clarified usage modes of cli-surf and added example for accessing the public API.
  • Updated description of available usage modes from two options to several, explicitly listing CLI via pipx, public API, and local server usage.
  • Renamed and split the server usage section into a dedicated public API section and a separate local server usage section.
  • Added a minimal curl example demonstrating how to call the public API endpoint.
README.md
Documented cloud infrastructure components in the architecture table.
  • Extended the architecture table to include a new Cloud row summarizing use of AWS (Lambda, ECR, API Gateway), CloudFlare (DNS), and GoDaddy (domain registration).
README.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@ryansurf ryansurf merged commit be9f25d into main Apr 10, 2026
10 checks passed
Copy link
Copy Markdown
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey - I've found 1 issue

Prompt for AI Agents
Please address the comments from this code review:

## Individual Comments

### Comment 1
<location path="README.md" line_range="339" />
<code_context>
 | Optional frontend | Streamlit |
 | Packaging | Poetry, pipx |
 | Containerization | Docker / Docker Compose |
+| Cloud | AWS (Lambda, ECR, API Gateway), CloudFlare (DNS resolver), GoDaddy (register domain name) |

 ---
</code_context>
<issue_to_address>
**issue (typo):** Correct "CloudFlare" capitalization to the official "Cloudflare".

```suggestion
| Cloud | AWS (Lambda, ECR, API Gateway), Cloudflare (DNS resolver), GoDaddy (register domain name) |
```
</issue_to_address>

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Comment thread README.md
| Optional frontend | Streamlit |
| Packaging | Poetry, pipx |
| Containerization | Docker / Docker Compose |
| Cloud | AWS (Lambda, ECR, API Gateway), CloudFlare (DNS resolver), GoDaddy (register domain name) |
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

issue (typo): Correct "CloudFlare" capitalization to the official "Cloudflare".

Suggested change
| Cloud | AWS (Lambda, ECR, API Gateway), CloudFlare (DNS resolver), GoDaddy (register domain name) |
| Cloud | AWS (Lambda, ECR, API Gateway), Cloudflare (DNS resolver), GoDaddy (register domain name) |

@codecov
Copy link
Copy Markdown

codecov bot commented Apr 10, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant