-
Notifications
You must be signed in to change notification settings - Fork 1
Update README with current services #339
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,89 @@ | ||
| import os | ||
| import re | ||
|
|
||
| def natural_key(string_): | ||
| """Helper to sort strings with numbers naturally (v1, v2, v10).""" | ||
| return [int(s) if s.isdigit() else s.lower() for s in re.split(r'(\d+)', string_)] | ||
|
|
||
| def extract_services(): | ||
| service_list = [] | ||
| # Matches 'service ServiceName {' and captures preceding comments | ||
| pattern = re.compile(r"((?://.*\n)+)?\s*service\s+(\w+)\s*\{", re.MULTILINE) | ||
|
|
||
| # Strictly filtering for serverless only | ||
| SKIPLIST = ["serverless"] | ||
|
|
||
| for root, _, files in os.walk("."): | ||
| for file in files: | ||
| relative_path = os.path.relpath(os.path.join(root, file), ".") | ||
|
|
||
| # Skip only if "serverless" is in the path or filename | ||
| if any(term in relative_path.lower() for term in SKIPLIST): | ||
| continue | ||
|
|
||
| if file.endswith(".proto"): | ||
| # Extract version from directory (e.g., proto/v1/auth.proto -> v1) | ||
| parent_dir = os.path.basename(root) | ||
| version = parent_dir if re.match(r'v\d+', parent_dir) else "v0" | ||
|
|
||
| with open(relative_path, "r", encoding="utf-8") as f: | ||
| content = f.read() | ||
| for match in pattern.finditer(content): | ||
| comment, name = match.groups() | ||
|
|
||
| # Skip only if "serverless" is in the service name | ||
| if any(term in name.lower() for term in SKIPLIST): | ||
| continue | ||
|
|
||
| description = "No description provided." | ||
| if comment: | ||
| description = " ".join([l.strip("// ").strip() for l in comment.strip().split("\n")]) | ||
|
|
||
| service_list.append({ | ||
| "name": name, | ||
| "path": relative_path, | ||
| "version": version, | ||
| "description": description | ||
| }) | ||
|
|
||
| # Sort: Primary = Name (alphabetical), Secondary = Version (v1, v2...) | ||
| # This keeps v1 and v2 of the same service together in the table. | ||
| return sorted(service_list, key=lambda x: (x["name"], natural_key(x["version"]))) | ||
|
|
||
| def generate_markdown_table(services): | ||
| lines = [ | ||
| "| Service Name | Version | Description |", | ||
| "| --- | --- | --- |" | ||
| ] | ||
| for s in services: | ||
| version_display = "N/A" if s["version"] == "v0" else s["version"] | ||
| lines.append(f"| [{s['name']}]({s['path']}) | **{version_display}** | {s['description']} |") | ||
| return "\n".join(lines) | ||
|
|
||
| def update_readme(new_table): | ||
| file_path = "README.md" | ||
| anchor = "Below is a list of the primary services available:" | ||
|
|
||
| if not os.path.exists(file_path): | ||
| return | ||
|
|
||
| with open(file_path, "r", encoding="utf-8") as f: | ||
| content = f.read() | ||
|
|
||
| if anchor not in content: | ||
| return | ||
|
|
||
| # Targets the anchor and the table block, ensuring content after is preserved | ||
| table_pattern = re.escape(anchor) + r"(\s*\n\s*\| Service Name \|.*?\|(?=\n\n|\n[^\s|]|$))?" | ||
|
|
||
| replacement = f"{anchor}\n\n{new_table}" | ||
| updated_content = re.sub(table_pattern, replacement, content, count=1, flags=re.DOTALL) | ||
|
|
||
| with open(file_path, "w", encoding="utf-8") as f: | ||
| f.write(updated_content) | ||
|
|
||
| if __name__ == "__main__": | ||
| services = extract_services() | ||
| table = generate_markdown_table(services) | ||
| update_readme(table) | ||
| print(f"Successfully updated README with {len(services)} services (Filtered: 'serverless').") |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This service will be dropped soon (or maybe is already merged)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Already merged, see: #336
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should we re-run the script, so it will be cleaned-up?