Skip to content

Commit

Permalink
fix(python): update installation instruction to use correct package n…
Browse files Browse the repository at this point in the history
…ame (#1508)

#### Summary
This PR updates the Python code generation template to correct the
package installation command. Previously, the generated comment
instructed users to install `baml`, but the correct package name is
`baml-py`.

#### Changes
- Updated `CONTENT_PREFIX` in `PythonLanguageFeatures` to use `pip
install baml-py` instead of `pip install baml`.

#### Why this is needed
- Ensures users install the correct Python package.
- Prevents potential confusion or installation errors.

#### Checklist
- [x] Code has been reviewed and tested.
- [x] All relevant documentation has been updated.
- [x] No breaking changes introduced.

<!-- ELLIPSIS_HIDDEN -->

----

> [!IMPORTANT]
> Corrects package installation command in comments to use `baml-py`
instead of `baml` across multiple files.
> 
>   - **Behavior**:
> - Corrects package installation command from `pip install baml` to
`pip install baml-py` in comments.
> - Affects `python_language_features.rs`, `__init__.py`, and
`async_client.py` among others.
>   - **Purpose**:
>     - Ensures correct package installation.
>     - Prevents user confusion and installation errors.
> 
> <sup>This description was created by </sup>[<img alt="Ellipsis"
src="https://img.shields.io/badge/Ellipsis-blue?color=175173">](https://www.ellipsis.dev?ref=BoundaryML%2Fbaml&utm_source=github&utm_medium=referral)<sup>
for 4dc0f95. It will automatically
update as commits are pushed.</sup>

<!-- ELLIPSIS_HIDDEN -->
  • Loading branch information
Elijas authored Feb 22, 2025
1 parent 2b19892 commit cd1a21b
Show file tree
Hide file tree
Showing 10 changed files with 10 additions and 10 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ impl LanguageFeatures for PythonLanguageFeatures {
#
# Welcome to Baml! To use this generated code, please run the following:
#
# $ pip install baml
# $ pip install baml-py
#
###############################################################################
Expand Down
2 changes: 1 addition & 1 deletion integ-tests/python/baml_client/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
#
# Welcome to Baml! To use this generated code, please run the following:
#
# $ pip install baml
# $ pip install baml-py
#
###############################################################################

Expand Down
2 changes: 1 addition & 1 deletion integ-tests/python/baml_client/async_client.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
#
# Welcome to Baml! To use this generated code, please run the following:
#
# $ pip install baml
# $ pip install baml-py
#
###############################################################################

Expand Down
2 changes: 1 addition & 1 deletion integ-tests/python/baml_client/globals.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
#
# Welcome to Baml! To use this generated code, please run the following:
#
# $ pip install baml
# $ pip install baml-py
#
###############################################################################

Expand Down
2 changes: 1 addition & 1 deletion integ-tests/python/baml_client/inlinedbaml.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
#
# Welcome to Baml! To use this generated code, please run the following:
#
# $ pip install baml
# $ pip install baml-py
#
###############################################################################

Expand Down
2 changes: 1 addition & 1 deletion integ-tests/python/baml_client/partial_types.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
#
# Welcome to Baml! To use this generated code, please run the following:
#
# $ pip install baml
# $ pip install baml-py
#
###############################################################################

Expand Down
2 changes: 1 addition & 1 deletion integ-tests/python/baml_client/sync_client.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
#
# Welcome to Baml! To use this generated code, please run the following:
#
# $ pip install baml
# $ pip install baml-py
#
###############################################################################

Expand Down
2 changes: 1 addition & 1 deletion integ-tests/python/baml_client/tracing.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
#
# Welcome to Baml! To use this generated code, please run the following:
#
# $ pip install baml
# $ pip install baml-py
#
###############################################################################

Expand Down
2 changes: 1 addition & 1 deletion integ-tests/python/baml_client/type_builder.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
#
# Welcome to Baml! To use this generated code, please run the following:
#
# $ pip install baml
# $ pip install baml-py
#
###############################################################################

Expand Down
2 changes: 1 addition & 1 deletion integ-tests/python/baml_client/types.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
#
# Welcome to Baml! To use this generated code, please run the following:
#
# $ pip install baml
# $ pip install baml-py
#
###############################################################################

Expand Down

0 comments on commit cd1a21b

Please sign in to comment.