Skip to content

Commit 9d6b34d

Browse files
dev to release/v0.5.1 (#27)
* Fix/requirements.txt (#25) * fix/pyproject.toml (#26) * add changelog
1 parent 5516f0b commit 9d6b34d

7 files changed

Lines changed: 49 additions & 2918 deletions

File tree

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
name: package-check
2+
3+
on:
4+
pull_request:
5+
6+
jobs:
7+
uv-lock-check:
8+
runs-on: ubuntu-latest
9+
steps:
10+
- name: Checkout code
11+
uses: actions/checkout@v4
12+
13+
- name: Install uv
14+
uses: astral-sh/setup-uv@v3
15+
with:
16+
enable-cache: true
17+
18+
- name: Check if uv.lock is up to date
19+
run: |
20+
uv lock --locked
21+
if ! git diff --exit-code uv.lock; then
22+
echo "❌ uv.lock is out of date!"
23+
echo "Please run 'uv lock' to update the lock file."
24+
exit 1
25+
else
26+
echo "✅ uv.lock is up to date!"
27+
fi

CHANGELOG.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# Changelog
22

3+
## [v0.5.1] - 2025-10-28
4+
5+
- Updated README.md instructions
6+
37
## [v0.5.0] - 2025-10-27
48

59
- Bump `pipelex` to `v0.14.0`: See `Pipelex` changelog [here](https://docs.pipelex.com/changelog/)

README.md

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,14 +19,21 @@ Once you've created your repository from it, then you can clone it and follow th
1919

2020
### Quick Start
2121

22-
The fastest way to get started (on Unix/MacOS/Linux):
23-
2422
```bash
25-
make install
26-
cp .env.example .env # Then add your API keys
23+
git clone https://github.com/yourusername/your-repo-name.git
24+
cd your-repo-name
25+
26+
# Create and activate virtual environment
27+
python -m venv .venv
28+
# or python3 -m venv .venv
29+
source .venv/bin/activate
30+
31+
# Install
32+
pip install . # or uv sync
2733
```
2834

29-
For detailed installation instructions, API key configuration options, and alternative setup methods, see **[PIPELEX_SETUP.md](PIPELEX_SETUP.md)**.
35+
After installation, configure your API keys by creating a `.env` file with your credentials.
36+
See more about API key configuration in the [documentation](https://docs.pipelex.com/pages/configuration/config-technical/inference-backend-config/).
3037

3138
---
3239

pyproject.toml

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[project]
22
name = "my-project"
3-
version = "0.5.0"
3+
version = "0.5.1"
44
description = "Replace this with your project description"
55
# authors = [{ name = "Your Name", email = "your.email@example.com" }]
66
license = "MIT"
@@ -13,13 +13,16 @@ classifiers = [
1313
"Programming Language :: Python :: 3.12",
1414
"Programming Language :: Python :: 3.13",
1515
"Operating System :: OS Independent",
16-
"License :: OSI Approved :: MIT License",
1716
]
1817

1918
dependencies = [
2019
"pipelex[mistralai,anthropic,google,google-genai,bedrock,fal]==0.14.0",
2120
]
2221

22+
[tool.setuptools]
23+
packages = ["my_project"]
24+
include-package-data = true
25+
2326
[project.optional-dependencies]
2427
dev = [
2528
"boto3-stubs>=1.35.24",

requirements-dev.txt

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

requirements.txt

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

uv.lock

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)