Skip to content

Commit

Permalink
Add release yaml for pypi
Browse files Browse the repository at this point in the history
shreyashankar committed Sep 17, 2024
1 parent 6c2d447 commit 0c9851d
Showing 3 changed files with 53 additions and 1 deletion.
46 changes: 46 additions & 0 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
name: Release

on:
push:
tags:
- "*.*.*"

permissions:
contents: read

jobs:
pypi-publish:
name: Upload release to PyPI
runs-on: ubuntu-latest
environment:
name: pypi
url: https://pypi.org/project/docetl/
permissions:
id-token: write
steps:
- name: Checkout code
uses: actions/checkout@v4

- name: Set up Python 3.10
uses: actions/setup-python@v5
with:
python-version: "3.10"

- name: Install Poetry
run: |
curl -sSL https://install.python-poetry.org | python - -y
- name: Update PATH
run: echo "$HOME/.local/bin" >> $GITHUB_PATH

- name: Update Poetry configuration
run: poetry config virtualenvs.create false

- name: Install dependencies
run: poetry install --sync --no-interaction

- name: Package project
run: poetry build

- name: Publish package distributions to PyPI
uses: pypa/gh-action-pypi-publish@release/v1
6 changes: 6 additions & 0 deletions docs/tutorial.md
Original file line number Diff line number Diff line change
@@ -24,6 +24,12 @@ DocETL uses [LiteLLM](https://github.com/BerriAI/litellm) under the hood, which
OPENAI_API_KEY=your_api_key_here
```

!!! warning "OpenAI Dependency"

DocETL has been primarily tested with OpenAI's language models and relies heavily on their structured output capabilities. While we aim to support other providers in the future, using OpenAI is currently recommended for the best experience and most reliable results.

If you choose to use a different provider, be aware that you may encounter unexpected behavior or reduced functionality, especially with operations that depend on structured outputs.

## Preparing the Data

Organize your user behavior data in a JSON file as a list of objects. Each object should have the following keys: "user_id", "country", and "log". The "log" field contains the user interaction logs.
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -2,7 +2,7 @@
name = "docetl"
version = "0.1.0"
description = "ETL with LLM operations."
authors = ["Shreya Shankar <ss.shankar505@gmail.com>"]
authors = ["Shreya Shankar <shreyashankar@berkeley.edu>"]
license = "MIT"
readme = "README.md"
packages = [

0 comments on commit 0c9851d

Please sign in to comment.