Repository navigation
Expand file tree
/
Copy pathmain.py
More file actions
291 lines (246 loc) · 11.9 KB
/
Copy pathmain.py
File metadata and controls
291 lines (246 loc) · 11.9 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
import html
import os
import re
# Single source of truth for diagram styling. This is prepended to every
# Mermaid fence, so diagrams must NOT carry their own `---config---`
# front matter: Mermaid only accepts front matter as the very first thing in
# the diagram, and this directive already occupies that position.
#
# `look: handDrawn` needs Mermaid >= 11 (bundled by mkdocs-material >= 9.6).
# `clusterBkg`/`clusterBorder` override Mermaid's hardcoded #ffffde subgraph
# yellow, which no other theme variable reaches.
# fontFamily is deliberately the system stack, NOT a webfont: Mermaid measures
# label widths at render time, and a webfont that finishes loading afterwards
# swaps in with different metrics and clips the last characters of labels.
# Must match --md-mermaid-font-family in custom.css.
MERMAID_WORKFLOW_INIT = """%%{init: {'look': 'handDrawn', 'theme': 'base', 'themeVariables': {'primaryColor': '#eef2ff', 'primaryBorderColor': '#1e40af', 'primaryTextColor': '#1e293b', 'lineColor': '#1e3a8a', 'edgeLabelBackground': '#ffffff', 'clusterBkg': '#fbfcff', 'clusterBorder': '#2563eb', 'fontFamily': '-apple-system, system-ui, Segoe UI, Roboto, Helvetica, Arial, sans-serif', 'fontSize': '15px'}, 'flowchart': {'nodeSpacing': 50, 'rankSpacing': 58, 'padding': 14, 'htmlLabels': true, 'curve': 'basis'}}}%%
"""
def mermaid_fence(source, language, class_name, options, md, **kwargs):
"""Render Mermaid diagrams in a compact, consistently framed workflow card."""
from pymdownx.superfences import fence_code_format
rendered = fence_code_format(
MERMAID_WORKFLOW_INIT + source,
language,
class_name,
options,
md,
**kwargs,
)
return rendered.replace(
'<pre class="mermaid">',
'<div class="workflow-diagram"><pre class="mermaid">',
1,
).replace("</pre>", "</pre></div>", 1)
VISUAL_JOURNEY_PAGES = {
"quickstart/index.md",
"devguide/ai/a2a-integration.md",
"devguide/ai/agent-framework-recipes.md",
"devguide/ai/conductor-agents.md",
"devguide/ai/first-ai-agent.md",
"devguide/ai/human-in-the-loop.md",
"devguide/ai/mcp-guide.md",
}
SDK_PAGE_CONFIG = {
"java": {
"name": "Java",
"examples": "https://github.com/conductor-oss/java-sdk/tree/main/examples",
"agentic_examples": "https://github.com/conductor-oss/java-sdk/tree/main/agent-examples",
"api_examples": None,
"agent": True,
},
"python": {
"name": "Python",
"examples": "https://github.com/conductor-oss/python-sdk/tree/main/examples",
"agentic_examples": "https://github.com/conductor-oss/python-sdk/tree/main/examples/agentic_workflows",
"api_examples": None,
"agent": True,
},
"go": {
"name": "Go",
"examples": "https://github.com/conductor-oss/go-sdk/tree/main/examples",
"agentic_examples": None,
"api_examples": None,
"agent": False,
},
"javascript": {
"name": "JavaScript / TypeScript",
"examples": "https://github.com/conductor-oss/javascript-sdk/tree/main/examples",
"agentic_examples": "https://github.com/conductor-oss/javascript-sdk/tree/main/examples/agentic-workflows",
"api_examples": "https://github.com/conductor-oss/javascript-sdk/tree/main/examples/api-journeys",
"agent": True,
},
"csharp": {
"name": "C# / .NET",
"examples": "https://github.com/conductor-oss/csharp-sdk/tree/main/csharp-examples",
"agentic_examples": None,
"api_examples": None,
"agent": True,
},
"ruby": {
"name": "Ruby",
"examples": "https://github.com/conductor-oss/ruby-sdk/tree/main/examples",
"agentic_examples": "https://github.com/conductor-oss/ruby-sdk/tree/main/examples/agentic_workflows",
"api_examples": None,
"agent": False,
},
"rust": {
"name": "Rust",
"examples": "https://github.com/conductor-oss/rust-sdk/tree/main/examples",
"agentic_examples": "https://github.com/conductor-oss/rust-sdk/tree/main/examples",
"api_examples": None,
"agent": False,
},
}
def sdk_intro(language):
"""Return the shared navigation and connection content for an SDK page."""
config = SDK_PAGE_CONFIG[language]
agent_link = "[Run your first agent](../../quickstart/first-agent.md)" if config["agent"] else "Coming soon"
def example_link(url, label):
return f"[{label}]({url})" if url else "Not currently maintained upstream"
csharp_note = "\n\nC# reads `CONDUCTOR_SERVER_URL` when you set `Configuration.BasePath`; pass `OrkesAuthenticationSettings` explicitly for key/secret authentication."
connection_note = csharp_note if language == "csharp" else "\n\nThis SDK reads these environment variables when constructing its standard client configuration."
return f'''## Start here
| Goal | Guide |
|---|---|
| Run a workflow | [Run your first workflow](../../quickstart/first-workflow.md) |
| Write a worker | [Write your first worker](../../quickstart/first-worker.md) |
| Build an agent | {agent_link} |
## Featured examples
| Category | Maintained upstream example |
|---|---|
| Workflow and worker | [Examples]({config["examples"]}) |
| Agentic workflow | {example_link(config["agentic_examples"], "Agentic workflow examples")} |
| API journey | {example_link(config["api_examples"], "API journey examples")} |
The agentic-workflow row covers SDK examples that orchestrate LLMs or tools. It is separate from the SDK-authored Conductor Agent quickstart, which is {"available above" if config["agent"] else "coming soon for this SDK"}.
!!! info "Connect to Conductor"
For local OSS, set `CONDUCTOR_SERVER_URL=http://localhost:8080/api`.
For Orkes Developer Edition, set `CONDUCTOR_SERVER_URL=https://developer.orkescloud.com/api`, `CONDUCTOR_AUTH_KEY`, and `CONDUCTOR_AUTH_SECRET`. Keep credentials out of source control.{connection_note}
'''
def on_pre_page_macros(env):
"""Place each compact page description directly after its H1.
Dedicated tutorial journeys already provide a richer visual introduction.
For the remaining public pages, reuse front-matter descriptions and remove
an identical first paragraph so the summary is additive only when needed.
"""
page = env.page
redirect_target = (page.meta or {}).get("redirect_to")
if redirect_target:
site_url = env.variables["config"]["site_url"].rstrip("/")
page.canonical_url = f"{site_url}/{redirect_target.lstrip('/')}"
meta = page.meta or {}
description = meta.get("description")
has_visual_hero = re.search(
r'<section class="(?:concept-hero|integration-hero|framework-hero|agent-runtime-hero|agent-concepts-hero)',
env.markdown,
)
# AI Cookbook recipes lead with their workflow diagram as the visual
# headline, so the summary card would push it below the fold. The
# front-matter description is still used for meta/og tags.
is_cookbook_recipe = page.file.src_path.startswith("devguide/ai/cookbook/")
if (
not description
or page.file.src_path in VISUAL_JOURNEY_PAGES
or has_visual_hero
or is_cookbook_recipe
):
return
heading = re.search(r"(?m)^# [^\n]+\n", env.markdown)
if not heading:
return
remaining = env.markdown[heading.end() :].lstrip("\n")
first_paragraph = re.match(r"(.+?)(?:\n\s*\n|$)", remaining, re.DOTALL)
summary_text = description
if first_paragraph:
candidate = " ".join(first_paragraph.group(1).split())
# Move only plain prose into the card. Rich Markdown stays in the
# document and the front-matter description remains the summary.
if candidate and not re.search(r"[`*_\[\]<>|]|^#{1,6} |^!!!|^```", candidate):
summary_text = candidate
remaining = remaining[first_paragraph.end() :].lstrip("\n")
elif remaining.startswith(description):
remaining = remaining[len(description) :].lstrip("\n")
source_repo = meta.get("source_repo")
source = ""
if source_repo:
source = f' <p class="page-summary__source">Source: <a href="{html.escape(source_repo, quote=True)}">{html.escape(source_repo.removeprefix("https://github.com/"))}</a></p>\n'
summary = (
'<aside class="page-summary" aria-label="Page summary">\n'
" <div>\n"
f' <p class="page-summary__text">{html.escape(summary_text)}</p>\n'
f"{source}"
" </div>\n"
"</aside>"
)
if meta.get("sdk_page"):
remaining = re.sub(r'^!!! info "Source"\n(?: .*\n?)+\n?', "", remaining)
remaining = re.sub(r'^## Connect to Conductor\n.*?(?=^## |\Z)', "", remaining, flags=re.DOTALL | re.MULTILINE)
remaining = re.sub(r'^## (Frequently Asked Questions|FAQ)\n.*?(?=^## |\Z)', "", remaining, flags=re.DOTALL | re.MULTILINE)
# The former README import appended a generated directory listing after
# the authored examples catalog. The shared featured table is the
# primary path; retain the authored catalog but omit that duplicate.
remaining = re.sub(r'^## Examples\n\nBrowse all examples on GitHub:.*\Z', "", remaining, flags=re.DOTALL | re.MULTILINE)
remaining = sdk_intro(meta["sdk_page"]) + "\n" + remaining.lstrip("\n")
env.markdown = env.markdown[: heading.end()] + "\n" + summary + "\n\n" + remaining
def define_env(env):
"Hook function"
@env.macro
def insert_content(key = None):
key = key or env.page.title
filename = env.variables['extra']['additional_content'][key]
return include_file(filename)
@env.macro
def include_file(filename):
prefix = env.variables['config']['docs_dir']
full_filename = os.path.join(prefix, filename)
with open(full_filename, 'r') as f:
lines = f.readlines()
return ''.join(lines)
"""
def copy_markdown_images(tmpRoot, markdown):
# root = os.path.dirname(os.path.dirname(self.page.url))
root = self.page.url
paths = []
p = re.compile("!\[.*\]\((.*)\)")
it = p.finditer(markdown)
for match in it:
path = match.group(1)
paths.append(path)
destinationPath = os.path.realpath(self.config['base_path'] + "/" +
root + "/gen_/" + path)
if not os.path.isfile(destinationPath):
print("Copying image: " + path + " to " + destinationPath)
os.makedirs(os.path.dirname(destinationPath), exist_ok=True)
shutil.copyfile(tmpRoot + "/" + path, destinationPath)
for path in paths:
markdown = markdown.replace(path, "gen_/" + path)
return markdown
"""
@env.macro
def snippet(file_path, section_name, num_sections=1):
p = re.compile("^#+ ")
m = p.search(section_name)
if m:
section_level = m.span()[1] - 1
root = env.variables['config']['docs_dir']
full_path = os.path.join(root, file_path)
content = ""
with open(full_path, 'r') as myfile:
content = myfile.read()
p = re.compile("^" + section_name + "$", re.MULTILINE)
start = p.search(content)
start_span = start.span()
p = re.compile("^#{1," + str(section_level) + "} ", re.MULTILINE)
result = ""
all = [x for x in p.finditer(content[start_span[1]:])]
print (len(all))
if len(all) == 0 or (num_sections-1) >= len(all):
result = content[start_span[0]:]
else:
end = all[num_sections-1]
end_index = end.span()[0]
result = content[start_span[0]:end_index + start_span[1]]
# If there are any images, find them, copy them
# result = copy_markdown_images(root, result)
return result
else:
return "Heading reference beginning in # is required"