Skip to content

Commit f730730

Browse files
Merge pull request Pipelex#93 from Pipelex/release/v0.4.1
2 parents df80052 + 2964694 commit f730730

7 files changed

Lines changed: 64 additions & 8 deletions

File tree

.cursor/rules/llms.mdc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ An llm_handle matches the handle (an id of sorts) with the full specification of
1717
- llm_version
1818
- llm_platform_choice
1919

20-
The declaration of llm_handleslooks like this in toml syntax:
20+
The declaration of llm_handles looks like this in toml syntax:
2121
```toml
2222
[llm_handles]
2323
gpt-4o-2024-08-06 = { llm_name = "gpt-4o", llm_version = "2024-08-06" }

CHANGELOG.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
11
# Changelog
22

3+
## [v0.4.1] - 2025-06-16
4+
5+
- Changed discord link to the new one: https://go.pipelex.com/discord
6+
- Added `hello-world` example in the `cookbook-examples` of the documentation.
7+
38
## [v0.4.0] - 2025-06-16
49

510
### Highlight: Complete documentation overhaul
@@ -113,7 +118,7 @@ is_reporting_enabled = true
113118

114119
## [v0.2.13] - 2025-06-06
115120

116-
- Added Discord badge on the Readme. Join the community! -> https://discord.gg/SReshKQjWt
121+
- Added Discord badge on the Readme. Join the community! -> https://go.pipelex.com/discord
117122
- Added a client for the Pipelex API. Join the waitlist -> https://www.pipelex.com/signup
118123
- Removed the `run_pipe_code` function. Replaced by `execute_pipeline` in `pipelex.pipeline.execute`.
119124
- Added llm deck `llm_for_img_to_text`.

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
alt="PyPI – latest release">
1919
<br/>
2020
<br/>
21-
<a href="https://discord.gg/SReshKQjWt"><img src="https://img.shields.io/badge/Discord-5865F2?logo=discord&logoColor=white" alt="Discord"></a>
21+
<a href="https://go.pipelex.com/discord"><img src="https://img.shields.io/badge/Discord-5865F2?logo=discord&logoColor=white" alt="Discord"></a>
2222
<a href="https://www.youtube.com/@PipelexAI"><img src="https://img.shields.io/badge/YouTube-FF0000?logo=youtube&logoColor=white" alt="YouTube"></a>
2323
<a href="https://pipelex.com"><img src="https://img.shields.io/badge/Homepage-03bb95?logo=google-chrome&logoColor=white&style=flat" alt="Website"></a>
2424
<a href="https://github.com/Pipelex/pipelex-cookbook"><img src="https://img.shields.io/badge/Cookbook-5a0dad?logo=github&logoColor=white&style=flat" alt="Cookbook"></a>
@@ -275,7 +275,7 @@ We welcome contributions! Please see our [Contributing Guidelines](CONTRIBUTING.
275275

276276
Join our vibrant Discord community to connect with other developers, share your experiences, and get help with your Pipelex projects!
277277

278-
[![Discord](https://img.shields.io/badge/Discord-5865F2?logo=discord&logoColor=white)](https://discord.gg/SReshKQjWt)
278+
[![Discord](https://img.shields.io/badge/Discord-5865F2?logo=discord&logoColor=white)](https://go.pipelex.com/discord)
279279

280280
## 💬 Support
281281

docs/pages/cookbook-examples/hello-world.md

Lines changed: 52 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,55 @@ You can find the complete code for this example in the Pipelex Cookbook reposito
1010

1111
[**➡️ View on GitHub: quick_start/hello_world.py**](https://github.com/Pipelex/pipelex-cookbook/blob/main/quick_start/hello_world.py)
1212

13+
## The Pipeline Explained
14+
15+
The `hello_world` function demonstrates the simplest possible Pipelex pipeline. It runs a single pipe that generates a haiku about "Hello World".
16+
17+
```python
18+
import asyncio
19+
20+
from pipelex import pretty_print
21+
from pipelex.pipelex import Pipelex
22+
from pipelex.pipeline.execute import execute_pipeline
23+
24+
25+
async def hello_world():
26+
27+
# Execute the pipeline
28+
pipe_output, _ = await execute_pipeline(
29+
pipe_code="hello_world",
30+
)
31+
32+
# Print the output
33+
pretty_print(pipe_output, title="Your first Pipelex output")
34+
35+
36+
# start Pipelex
37+
Pipelex.make()
38+
# run sample using asyncio
39+
asyncio.run(hello_world())
40+
```
41+
42+
This example shows the minimal setup needed to run a Pipelex pipeline: initialize Pipelex, execute a pipeline by its code name, and pretty-print the results.
43+
44+
## The Pipeline Definition: `hello_world.toml`
45+
46+
The pipeline definition is extremely simple - it's a single LLM call that generates a haiku:
47+
48+
```toml
49+
domain = "quick_start"
50+
definition = "Discovering Pipelex"
51+
52+
[pipe]
53+
[pipe.hello_world]
54+
PipeLLM = "Write text about Hello World."
55+
output = "Text"
56+
llm = { llm_handle = "gpt-4o-mini", temperature = 0.9, max_tokens = "auto" }
57+
prompt = """
58+
Write a haiku about Hello World.
59+
"""
60+
```
61+
1362
## How to run
1463

1564
1. Clone the cookbook repository:
@@ -25,4 +74,6 @@ You can find the complete code for this example in the Pipelex Cookbook reposito
2574
4. Run the example:
2675
```bash
2776
python quick_start/hello_world.py
28-
```
77+
```
78+
79+
Expected output: A haiku about "Hello World" displayed with pretty formatting.

docs/pages/installation/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,4 +61,4 @@ Learn more about pipelex_libraries in our [Libraries documentation](../build-rel
6161
- `pipelex init-config`: This cli command will create a `pipelex.toml` file at the root of the project, with basic configuration. This configuration file gathers all configuration for feature flags, logging, cost reporting, and so on... Learn more in our [Configuration documentation](../configuration/index.md)
6262

6363

64-
💡 _Any troubles? Have a look at our [Cookbook](https://github.com/Pipelex/pipelex-cookbook)! and come ask for help on our [Discord](https://discord.gg/SReshKQjWt)_
64+
💡 _Any troubles? Have a look at our [Cookbook](https://github.com/Pipelex/pipelex-cookbook)! and come ask for help on our [Discord](https://go.pipelex.com/discord)_

mkdocs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ extra:
4242
link: https://x.com/PipelexAI
4343
name: Pipelex on X
4444
- icon: fontawesome/brands/discord
45-
link: https://discord.gg/SReshKQjWt
45+
link: https://go.pipelex.com/discord
4646
name: Pipelex on Discord
4747
generator: false
4848

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[project]
22
name = "pipelex"
3-
version = "0.4.0"
3+
version = "0.4.1"
44
description = "Pipelex is an open-source dev tool based on a simple declarative language that lets you define replicable, structured, composable LLM pipelines."
55
authors = [{ name = "Evotis S.A.S.", email = "evotis@pipelex.com" }]
66
maintainers = [{ name = "Pipelex staff", email = "oss@pipelex.com" }]

0 commit comments

Comments
 (0)