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
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ Longer [video intro & walkthrough](https://www.youtube.com/watch?v=rEZ4oDN0GdU).
Install from `pypi`:

```bash
pip install "burr[start]"
pip install "apache-burr[start]"
```

(see [the docs](https://burr.apache.org/getting_started/install/) if you're using poetry)
Expand Down
4 changes: 2 additions & 2 deletions burr/core/action.py
Original file line number Diff line number Diff line change
Expand Up @@ -1462,7 +1462,7 @@ def pydantic(
from burr.integrations.pydantic import pydantic_action
except ImportError:
raise ImportError(
"Please install pydantic to use the pydantic decorator. pip install burr[pydantic]"
"Please install pydantic to use the pydantic decorator. pip install apache-burr[pydantic]"
)

return pydantic_action(
Expand Down Expand Up @@ -1525,7 +1525,7 @@ def pydantic(
from burr.integrations.pydantic import pydantic_streaming_action
except ImportError:
raise ImportError(
"Please install pydantic to use the pydantic decorator. pip install 'burr[pydantic]'"
"Please install pydantic to use the pydantic decorator. pip install 'apache-burr[pydantic]'"
)

return pydantic_streaming_action(
Expand Down
2 changes: 1 addition & 1 deletion burr/core/graph.py
Original file line number Diff line number Diff line change
Expand Up @@ -206,7 +206,7 @@ def visualize(
except ModuleNotFoundError:
logger.exception(
" graphviz is required for visualizing the application graph. Install it with:"
'\n\n pip install "burr[graphviz]" or pip install graphviz \n\n'
'\n\n pip install "apache-burr[graphviz]" or pip install graphviz \n\n'
)
return
digraph_attr = dict(
Expand Down
2 changes: 1 addition & 1 deletion burr/tracking/server/s3/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ The server is executable by a simple python command (although in production you'
To get everything you need, you can install as you would any python library:

```bash
pip install "burr[tracking-server-s3, cli]"
pip install "apache-burr[tracking-server-s3, cli]"
```

Note that this enables you to run through the CLI -- you won't need the CLI target to run in production,
Expand Down
2 changes: 1 addition & 1 deletion docs/concepts/tracking.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Tracking Burr

Burr's telemetry system is built in and easy to integrate. It allows you to understand
the flow of your application, and watch it make decisions in real time. You can run it
with sample projects by running ``burr`` in the terminal after ``pip install "burr[start]"``.
with sample projects by running ``burr`` in the terminal after ``pip install "apache-burr[start]"``.

Burr comes with a telemetry system that allows tracking a variety of information for debugging,
both in development and production.
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/chatbots/rag-chatbot-hamilton.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
},
"outputs": [],
"source": [
"!pip install burr[start] sf-hamilton[visualization] openai "
"!pip install apache-burr[start] sf-hamilton[visualization] openai "
]
},
{
Expand Down
48 changes: 24 additions & 24 deletions docs/getting_started/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ along with a fully built server.

.. code-block:: bash

pip install "burr[start]"
pip install "apache-burr[start]"

This will give you tools to visualize, track, and interact with the UI. You can explore the UI (including some sample projects)
simply by running the command ``burr``. Up next we'll write our own application and follow it in the UI.
Expand All @@ -48,135 +48,135 @@ Description of different targets

.. code-block:: bash

pip install burr
pip install apache-burr

This only installs the framework. Zero other dependencies. All other installs below all install the
framework + some other dependencies. Note you can combine installing multiple optional dependencies with commas, e.g.
``pip install "burr[cli,tracking]"`` installs both the CLI and tracking + UI dependencies.
``pip install "apache-burr[cli,tracking]"`` installs both the CLI and tracking + UI dependencies.

.. code-block:: bash

pip install "burr[cli]"
pip install "apache-burr[cli]"

This installs the dependencies to run the burr CLI, i.e. `burr --help`.

.. code-block:: bash

pip install "burr[developer]"
pip install "apache-burr[developer]"

This installs all the dependencies for developing locally.

.. code-block:: bash

pip install "burr[documentation]"
pip install "apache-burr[documentation]"

This installs the dependencies to build the documentation.

.. code-block:: bash

pip install "burr[examples]"
pip install "apache-burr[examples]"

This installs the dependencies for the examples.


.. code-block:: bash

pip install "burr[graphviz]"
pip install "apache-burr[graphviz]"

This installs the dependencies to visualize the graph.

.. code-block:: bash

pip install "burr[hamilton]"
pip install "apache-burr[hamilton]"

This installs the dependencies for Hamilton.

.. code-block:: bash

pip install "burr[haystack]"
pip install "apache-burr[haystack]"

This installs the dependencies for Haystack.

.. code-block:: bash

pip install "burr[learn]"
pip install "apache-burr[learn]"

This installs the dependencies for the UI, CLI, and running demos. It is equivalent to `start` below.

.. code-block:: bash

pip install "burr[opentelemetry]"
pip install "apache-burr[opentelemetry]"

This installs the dependencies for using OpenTelemetry with Burr.

.. code-block:: bash

pip install "burr[postgresql]"
pip install "apache-burr[postgresql]"

This installs the dependencies for PostgreSQL.

.. code-block:: bash

pip install "burr[pydantic]"
pip install "apache-burr[pydantic]"

This installs the dependencies for Pydantic.

.. code-block:: bash

pip install "burr[redis]"
pip install "apache-burr[redis]"

This installs the dependencies for Redis.

.. code-block:: bash

pip install "burr[start]"
pip install "apache-burr[start]"

This installs the dependencies for the UI, CLI, and running demos. It is equivalent to `learn` above.

.. code-block:: bash

pip install "burr[streamlit]"
pip install "apache-burr[streamlit]"

This installs the dependencies for Streamlit.

.. code-block:: bash

pip install "burr[tests]"
pip install "apache-burr[tests]"

This installs the dependencies for running unit tests.

.. code-block:: bash

pip install "burr[tracking]"
pip install "apache-burr[tracking]"

This installs the client and server dependencies for tracking and running the UI from tracking that is on a filesystem.

.. code-block:: bash

pip install "burr[tracking-client]"
pip install "apache-burr[tracking-client]"

This installs the client dependencies for tracking to a filesystem.

.. code-block:: bash

pip install "burr[tracking-client-s3]"
pip install "apache-burr[tracking-client-s3]"

This installs the client dependencies for tracking to S3.

.. code-block:: bash

pip install "burr[tracking-server-s3]"
pip install "apache-burr[tracking-server-s3]"

This installs the server dependencies to run the UI and load tracking that was sent to S3.

.. code-block:: bash

pip install "burr[tracking-server]"
pip install "apache-burr[tracking-server]"

This installs the server dependencies for running the UI off a filesystem.

.. code-block:: bash

pip install "burr[bedrock]"
pip install "apache-burr[bedrock]"

This installs ``boto3`` for the :ref:`Amazon Bedrock integration <bedrock-integration>` (``BedrockAction`` / ``BedrockStreamingAction``).
2 changes: 1 addition & 1 deletion docs/getting_started/up-next.rst
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ If you haven't already:

.. code-block:: bash

pip install burr[start]
pip install apache-burr[start]

Then:

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/integrations/bedrock.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Install the optional extra (pulls ``boto3``):

.. code-block:: bash

pip install "burr[bedrock]"
pip install "apache-burr[bedrock]"

IAM permissions must allow ``bedrock:InvokeModel`` / streaming equivalents for your
chosen models; see AWS documentation for your account and model IDs.
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/integrations/streamlit.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Install with pypi:

.. code-block:: bash

pip install burr[streamlit]
pip install apache-burr[streamlit]

.. autoclass:: burr.integrations.streamlit.AppState
:members:
Expand Down
2 changes: 1 addition & 1 deletion examples/conversational-rag/simple_example/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ of the conversation and asking for user inputs.
To run this example, install Burr and the necessary dependencies:

```bash
pip install "burr[start]" -r requirements.txt
pip install "apache-burr[start]" -r requirements.txt
```

Then run the server in the background:
Expand Down
2 changes: 1 addition & 1 deletion examples/conversational-rag/simple_example/notebook.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
}
},
"source": [
"!pip install burr[start] sf-hamilton[visualization] openai "
"!pip install apache-burr[start] sf-hamilton[visualization] openai "
],
"outputs": []
},
Expand Down
2 changes: 1 addition & 1 deletion examples/custom-serde/notebook.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
"metadata": {},
"outputs": [],
"source": [
"!pip install burr[start] langchain_core langchain_community pydantic\n",
"!pip install apache-burr[start] langchain_core langchain_community pydantic\n",
"# we only need these to show case the automatic serialization and deserialization that Burr has."
]
},
Expand Down
2 changes: 1 addition & 1 deletion examples/deep-researcher/notebook.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@
],
"execution_count": 1,
"source": [
"!pip install burr[start]\n",
"!pip install apache-burr[start]\n",
"!pip install openai\n",
"!pip install tavily-python"
],
Expand Down
2 changes: 1 addition & 1 deletion examples/email-assistant/notebook.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
"cell_type": "code",
"outputs": [],
"execution_count": null,
"source": "!pip install burr[start] openai",
"source": "!pip install apache-burr[start] openai",
"id": "25717d145f989eec"
},
{
Expand Down
2 changes: 1 addition & 1 deletion examples/hello-world-counter/notebook.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
"cell_type": "code",
"outputs": [],
"execution_count": null,
"source": "!pip install burr[start]",
"source": "!pip install apache-burr[start]",
"id": "500d692cd72c67b3"
},
{
Expand Down
2 changes: 1 addition & 1 deletion examples/image-telephone/notebook.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
},
"outputs": [],
"source": [
"!pip install burr[start] openai requests"
"!pip install apache-burr[start] openai requests"
]
},
{
Expand Down
2 changes: 1 addition & 1 deletion examples/llm-adventure-game/notebook.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
},
"outputs": [],
"source": [
"!pip install burr[start]"
"!pip install apache-burr[start]"
]
},
{
Expand Down
2 changes: 1 addition & 1 deletion examples/multi-agent-collaboration/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ More functionality is on the roadmap!
Install the dependencies:

```bash
pip install "burr[start]" -r requirements.txt
pip install "apache-burr[start]" -r requirements.txt
```

Make sure you have the API Keys in your environment:
Expand Down
2 changes: 1 addition & 1 deletion examples/multi-agent-collaboration/hamilton/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ More functionality is on the roadmap!
Install the dependencies:

```bash
pip install "burr[start]" -r requirements.txt
pip install "apache-burr[start]" -r requirements.txt
```

Make sure you have the API Keys in your environment:
Expand Down
2 changes: 1 addition & 1 deletion examples/multi-agent-collaboration/lcel/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ More functionality is on the roadmap!
Install the dependencies:

```bash
pip install "burr[start]" -r requirements.txt
pip install "apache-burr[start]" -r requirements.txt
```

Make sure you have the API Keys in your environment:
Expand Down
2 changes: 1 addition & 1 deletion examples/multi-modal-chatbot/notebook.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
"cell_type": "code",
"outputs": [],
"execution_count": null,
"source": "!pip install burr[start]",
"source": "!pip install apache-burr[start]",
"id": "a1e0bae74e5d0d91"
},
{
Expand Down
2 changes: 1 addition & 1 deletion examples/other-examples/cowsay/notebook.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
"metadata": {},
"outputs": [],
"source": [
"!pip install burr[start]"
"!pip install apache-burr[start]"
]
},
{
Expand Down
2 changes: 1 addition & 1 deletion examples/ray/notebook.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@
],
"source": [
"# execute to load the Burr and Hamilton extensions\n",
"%pip install burr openai ray\n",
"%pip install apache-burr openai ray\n",
"%load_ext burr.integrations.notebook"
]
},
Expand Down
2 changes: 1 addition & 1 deletion examples/simple-chatbot-intro/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Example that goes with [introductory blog post](https://blog.dagworks.io/p/burr-
## 🏃Quick start

```bash
pip install "burr[start]" jupyter
pip install "apache-burr[start]" jupyter
```

Run the notebook:
Expand Down
Loading
Loading