Skip to content

Commit 2420e03

Browse files
actions-useractions-user
committed
docs: update codeboarding documentation in advanced-customization
## 📚 Documentation Update This commit contains updated documentation files fetched from the CodeBoarding service and copied to the advanced-customization section. ### 📊 Summary - Documentation files created/updated: 3 - JSON files created/updated: 4 - Documentation directory: .codeboarding/ - JSON directory: .codeboarding/ - Output format: .md - Repository analyzed: https://github.com/Pipelex/pipelex - Destination: docs/pages/advanced-customization/ The generated .md files have been automatically copied to the advanced-customization documentation section. 🤖 This commit was automatically generated by the CodeBoarding documentation update workflow.
1 parent 78f618d commit 2420e03

18 files changed

Lines changed: 907 additions & 1459 deletions

‎.codeboarding/AI_Services_Integration.json‎

Lines changed: 0 additions & 175 deletions
This file was deleted.

‎.codeboarding/AI_Services_Integration.md‎

Lines changed: 0 additions & 42 deletions
This file was deleted.

‎.codeboarding/CLI_User_Interface.json‎

Lines changed: 155 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,155 @@
1+
{
2+
"description": "The Pipelex system's command-line interface is orchestrated by the PipelexCLI component, which acts as the central dispatcher for user commands. It delegates specific tasks to CLI Commands, such as run, build, and validate. These commands, in turn, interact with the Pipelex Core, which embodies the fundamental logic for pipeline execution, validation, and bundle management. The Pipelex Core relies on Pipelex System Configuration for managing settings and data, and directly manages Pipelex Pipeline instances. The Pipelex Builder component is responsible for generating pipelines based on user requirements, a function initiated by relevant CLI Commands. This architecture ensures a clear separation of concerns, with the CLI handling user interaction and command dispatch, while the core components manage the underlying pipeline logic and data.",
3+
"components": [
4+
{
5+
"name": "PipelexCLI",
6+
"description": "Serves as the primary entry point for the command-line interface. It initializes the CLI application, registers available commands, parses user input, and dispatches control to the appropriate command handler. It acts as the orchestrator for user interactions with the Pipelex system.",
7+
"referenced_source_code": [
8+
{
9+
"qualified_name": "pipelex.cli._cli.PipelexCLI",
10+
"reference_file": "pipelex/cli/_cli.py",
11+
"reference_start_line": 14,
12+
"reference_end_line": 27
13+
}
14+
],
15+
"assigned_files": [
16+
"pipelex/cli/_cli.py",
17+
"pipelex/cli/__init__.py"
18+
],
19+
"can_expand": true
20+
},
21+
{
22+
"name": "CLI Commands",
23+
"description": "Each module within `pipelex.cli.commands` implements the specific business logic for a particular CLI command (e.g., run, build, validate). This includes handling command-line arguments, validating inputs, and invoking the relevant core Pipelex functionalities to perform tasks such as running, building, validating, or managing pipelines and concepts.",
24+
"referenced_source_code": [
25+
{
26+
"qualified_name": "pipelex.cli.commands.run_cmd.run_cmd",
27+
"reference_file": "pipelex/cli/commands/run_cmd.py",
28+
"reference_start_line": 19,
29+
"reference_end_line": 182
30+
},
31+
{
32+
"qualified_name": "pipelex.cli.commands.build_cmd.build_app",
33+
"reference_file": "pipelex/cli/commands/build_cmd.py",
34+
"reference_start_line": 24,
35+
"reference_end_line": 24
36+
},
37+
{
38+
"qualified_name": "pipelex.cli.commands.validate_cmd.validate_cmd",
39+
"reference_file": "pipelex/cli/commands/validate_cmd.py",
40+
"reference_start_line": 33,
41+
"reference_end_line": 148
42+
}
43+
],
44+
"assigned_files": [
45+
"pipelex/cli/commands/__init__.py",
46+
"pipelex/cli/commands/build_cmd.py",
47+
"pipelex/cli/commands/kit_cmd.py",
48+
"pipelex/cli/commands/init_cmd.py",
49+
"pipelex/cli/commands/validate_cmd.py",
50+
"pipelex/cli/commands/run_cmd.py",
51+
"pipelex/cli/commands/show_cmd.py"
52+
],
53+
"can_expand": true
54+
},
55+
{
56+
"name": "Pipelex Core",
57+
"description": "Encapsulates the central functionalities of the Pipelex system, including pipeline execution, validation logic, and interaction with bundles. It provides the underlying mechanisms for processing and managing pipelines and their associated data.",
58+
"referenced_source_code": [
59+
{
60+
"qualified_name": "pipelex.core.Pipelex",
61+
"reference_file": "pipelex/pipelex.py",
62+
"reference_start_line": 64,
63+
"reference_end_line": 292
64+
},
65+
{
66+
"qualified_name": "pipelex.core.interpreter.PipelexInterpreter",
67+
"reference_file": "pipelex/core/interpreter.py",
68+
"reference_start_line": 17,
69+
"reference_end_line": 92
70+
}
71+
],
72+
"assigned_files": [],
73+
"can_expand": true
74+
},
75+
{
76+
"name": "Pipelex System Configuration",
77+
"description": "Manages the configuration settings and input/output data for the Pipelex system. This includes loading and saving JSON files for inputs and outputs, and potentially other system-wide settings.",
78+
"referenced_source_code": [
79+
{
80+
"qualified_name": "pipelex.utils.io.load_json_dict_from_path",
81+
"reference_file": "pipelex/tools/misc/json_utils.py",
82+
"reference_start_line": 106,
83+
"reference_end_line": 128
84+
},
85+
{
86+
"qualified_name": "pipelex.utils.io.save_as_json_to_path",
87+
"reference_file": "pipelex/tools/misc/json_utils.py",
88+
"reference_start_line": 59,
89+
"reference_end_line": 81
90+
}
91+
],
92+
"assigned_files": [],
93+
"can_expand": false
94+
},
95+
{
96+
"name": "Pipelex Pipeline",
97+
"description": "Represents the actual pipelines within the Pipelex system, including their definition, structure, and execution flow. This component is responsible for the logical representation and operational aspects of a pipeline.",
98+
"referenced_source_code": [
99+
{
100+
"qualified_name": "pipelex.core.pipeline.execute_pipeline",
101+
"reference_file": "pipelex/pipeline/execute.py",
102+
"reference_start_line": 22,
103+
"reference_end_line": 107
104+
},
105+
{
106+
"qualified_name": "pipelex.core.pipeline.get_required_pipe",
107+
"reference_file": "pipelex/core/pipes/pipe_abstract.py",
108+
"reference_start_line": 41,
109+
"reference_end_line": 49
110+
}
111+
],
112+
"assigned_files": [],
113+
"can_expand": true
114+
},
115+
{
116+
"name": "Unclassified",
117+
"description": "Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)",
118+
"referenced_source_code": [],
119+
"assigned_files": [],
120+
"can_expand": false
121+
}
122+
],
123+
"components_relations": [
124+
{
125+
"relation": "delegates to",
126+
"src_name": "PipelexCLI",
127+
"dst_name": "CLI Commands"
128+
},
129+
{
130+
"relation": "interacts with",
131+
"src_name": "PipelexCLI",
132+
"dst_name": "Pipelex System Configuration"
133+
},
134+
{
135+
"relation": "initiates operations on",
136+
"src_name": "CLI Commands",
137+
"dst_name": "Pipelex Core"
138+
},
139+
{
140+
"relation": "interacts with",
141+
"src_name": "CLI Commands",
142+
"dst_name": "Pipelex System Configuration"
143+
},
144+
{
145+
"relation": "manages",
146+
"src_name": "Pipelex Core",
147+
"dst_name": "Pipelex Pipeline"
148+
},
149+
{
150+
"relation": "interacts with",
151+
"src_name": "Pipelex Core",
152+
"dst_name": "Pipelex System Configuration"
153+
}
154+
]
155+
}

0 commit comments

Comments
 (0)