Skip to content

Update python-sdks-user-guide.md#5385

Merged
hezhangjian merged 3 commits intoapolloconfig:masterfrom
OuterCloud:patch-1
May 12, 2025
Merged

Update python-sdks-user-guide.md#5385
hezhangjian merged 3 commits intoapolloconfig:masterfrom
OuterCloud:patch-1

Conversation

@OuterCloud
Copy link
Contributor

@OuterCloud OuterCloud commented May 9, 2025

What's the purpose of this PR

新增 python 客户端。

Which issue(s) this PR fixes:

Fixes #

  • 支持 python 3.13,去掉 telnetlib 的使用。

Brief changelog

  • 支持实时更新:支持 Apollo 配置项获取与实时更新。
  • 支持密钥:支持有密钥/无密钥的 Apollo 应用配置获取。
  • 支持分布式部署:支持基于分布式部署的 Apollo 应用配置获取。
  • 有容灾机制:当一个 Apollo 服务节点不可用时,会自动切换到下一个可用的服务节点。

Follow this checklist to help us incorporate your contribution quickly and easily:

  • Read the Contributing Guide before making this pull request.
  • Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
  • Write necessary unit tests to verify the code.
  • Run mvn clean test to make sure this pull request doesn't break anything.
  • Update the CHANGES log.

Summary by CodeRabbit

  • Documentation
    • Added a new section highlighting the "Apollo Python 客户端 4" with a link to the "OuterCloud/pyapollo" project and an acknowledgment for the contributor.
    • Added a corresponding section titled "Apollo Python client 4" in the English documentation with project details and contributor thanks.

@dosubot dosubot bot added the size:XS This PR changes 0-9 lines, ignoring generated files. label May 9, 2025
@coderabbitai
Copy link
Contributor

coderabbitai bot commented May 9, 2025

Walkthrough

A new section was added to both the Chinese and English Python SDK user guide documentation, introducing "Apollo Python 客户端 4" / "Apollo Python client 4." This section provides a link to the OuterCloud/pyapollo GitHub project and acknowledges the contributor. No existing content was changed or removed.

Changes

File(s) Change Summary
docs/zh/client/python-sdks-user-guide.md, docs/en/client/python-sdks-user-guide.md Added a new section for "Apollo Python 客户端 4" / "Apollo Python client 4" with a project link and contributor acknowledgment.

Poem

In the garden of docs, a new sprout appears,
Apollo Python 客户端 4 now cheers!
With OuterCloud’s help, the guide grows tall,
Linking to GitHub, inviting all.
Hopping through updates, I wiggle my nose,
Sharing new clients as the documentation grows! 🐇✨

Tip

⚡️ Faster reviews with caching
  • CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.

Enjoy the performance boost—your workflow just got faster.


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between e050998 and b2442f4.

📒 Files selected for processing (1)
  • docs/en/client/python-sdks-user-guide.md (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • docs/en/client/python-sdks-user-guide.md
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: build (8)

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@github-actions
Copy link

github-actions bot commented May 9, 2025

CLA Assistant Lite bot All contributors have signed the CLA ✍️ ✅

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (2)
docs/zh/client/python-sdks-user-guide.md (2)

16-17: Remove .git suffix from the GitHub URL for consistency
Most existing entries omit the trailing .git in their links. Please update this line to:

- 项目地址:[OuterCloud/pyapollo](https://github.com/OuterCloud/pyapollo.git)
+ 项目地址:[OuterCloud/pyapollo](https://github.com/OuterCloud/pyapollo)

16-20: Unify link text formatting across entries
Other sections display either just the repo name (pyapollo) or a hyphenated username-repo (BruceWW-pyapollo). To maintain a consistent style, consider changing the link text here—for example, use pyapollo or OuterCloud-pyapollo instead of OuterCloud/pyapollo.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 6de040a and e050998.

📒 Files selected for processing (1)
  • docs/zh/client/python-sdks-user-guide.md (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: build (8)

@nobodyiam
Copy link
Member

Thanks for your contribution. Please update the English version of the document and sign the CLA as instructed by the CLA bot.

@OuterCloud
Copy link
Contributor Author

I have read the CLA Document and I hereby sign the CLA

@dosubot dosubot bot added size:S This PR changes 10-29 lines, ignoring generated files. and removed size:XS This PR changes 0-9 lines, ignoring generated files. labels May 12, 2025
@OuterCloud
Copy link
Contributor Author

Thanks for your contribution. Please update the English version of the document and sign the CLA as instructed by the CLA bot.

Done.

@dosubot dosubot bot added the lgtm This PR has been approved by a maintainer label May 12, 2025
@hezhangjian hezhangjian merged commit 56ec144 into apolloconfig:master May 12, 2025
8 checks passed
@github-actions github-actions bot locked and limited conversation to collaborators May 12, 2025
@nobodyiam nobodyiam added this to the 2.5.0 milestone Feb 19, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

lgtm This PR has been approved by a maintainer size:S This PR changes 10-29 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

Comments