Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions .github/workflows/package-check.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
name: package-check

on:
pull_request:

jobs:
uv-lock-check:
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v4

- name: Install uv
uses: astral-sh/setup-uv@v3
with:
enable-cache: true

- name: Check if uv.lock is up to date
run: |
uv lock --locked
if ! git diff --exit-code uv.lock; then
echo "❌ uv.lock is out of date!"
echo "Please run 'uv lock' to update the lock file."
exit 1
else
echo "✅ uv.lock is up to date!"
fi
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Changelog

## [v0.5.1] - 2025-10-28

- Updated README.md instructions

## [v0.5.0] - 2025-10-27

- Bump `pipelex` to `v0.14.0`: See `Pipelex` changelog [here](https://docs.pipelex.com/changelog/)
Expand Down
17 changes: 12 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,14 +19,21 @@ Once you've created your repository from it, then you can clone it and follow th

### Quick Start

The fastest way to get started (on Unix/MacOS/Linux):

```bash
make install
cp .env.example .env # Then add your API keys
git clone https://github.com/yourusername/your-repo-name.git
cd your-repo-name

# Create and activate virtual environment
python -m venv .venv
# or python3 -m venv .venv
source .venv/bin/activate

# Install
pip install . # or uv sync
```

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

---

Expand Down
7 changes: 5 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[project]
name = "my-project"
version = "0.5.0"
version = "0.5.1"
description = "Replace this with your project description"
# authors = [{ name = "Your Name", email = "your.email@example.com" }]
license = "MIT"
Expand All @@ -13,13 +13,16 @@ classifiers = [
"Programming Language :: Python :: 3.12",
"Programming Language :: Python :: 3.13",
"Operating System :: OS Independent",
"License :: OSI Approved :: MIT License",
]

dependencies = [
"pipelex[mistralai,anthropic,google,google-genai,bedrock,fal]==0.14.0",
]

[tool.setuptools]
packages = ["my_project"]
include-package-data = true

[project.optional-dependencies]
dev = [
"boto3-stubs>=1.35.24",
Expand Down
1,566 changes: 0 additions & 1,566 deletions requirements-dev.txt

This file was deleted.

1,344 changes: 0 additions & 1,344 deletions requirements.txt

This file was deleted.

2 changes: 1 addition & 1 deletion uv.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading