Skip to content

armgit / burr

Public Imported from GitHub
0

Build applications that make decisions (chatbots, agents, simulations, etc...). Monitor, trace, persist, and execute on your own infrastructure.

Helps people install with poetry

elijahbenizzy43ade4ae91d6
diff --git a/README.md b/README.md
index 0c0e8f66..7b4e57ec 100644
--- a/README.md
+++ b/README.md
@@ -19,6 +19,8 @@ Install from `pypi`:
pip install "burr[start]"
```
+(see [the docs](https://burr.dagworks.io/getting_started/install/) if you're using poetry)
+
Then run the UI server:
```bash
diff --git a/burr/cli/__main__.py b/burr/cli/__main__.py
index 1d9ab69a..31e14319 100644
--- a/burr/cli/__main__.py
+++ b/burr/cli/__main__.py
@@ -24,7 +24,6 @@ try:
except ImportError as e:
require_plugin(
e,
- ["click", "requests", "loguru"],
"start",
)
diff --git a/burr/integrations/base.py b/burr/integrations/base.py
index c79f18e1..6baa6588 100644
--- a/burr/integrations/base.py
+++ b/burr/integrations/base.py
@@ -1,6 +1,7 @@
-def require_plugin(import_error: ImportError, libraries: list[str], plugin_name: str):
+def require_plugin(import_error: ImportError, plugin_name: str):
raise ImportError(
- f"Missing plugin {plugin_name}! To use the {plugin_name} plugin, you must install the following libraries: {libraries}."
- f"You can install this with burr[{plugin_name}] or pip install {' '.join(libraries)} (replace with your "
- f"package manager of choice)."
+ f"Missing plugin {plugin_name}! To use the {plugin_name} plugin, you must install the 'extras' target [{plugin_name}] with burr[{plugin_name}] "
+ f"(replace with your package manager of choice). Note that, if you're using poetry, you cannot install burr with burr[start], so "
+ f"you'll have to install the components individually. See https://burr.dagworks.io/getting_started/install/ "
+ f"for more details."
) from import_error
diff --git a/burr/integrations/persisters/b_redis.py b/burr/integrations/persisters/b_redis.py
index 3a5df962..65f38285 100644
--- a/burr/integrations/persisters/b_redis.py
+++ b/burr/integrations/persisters/b_redis.py
@@ -4,7 +4,7 @@ try:
import redis # can't name module redis because this import wouldn't work.
except ImportError as e:
- base.require_plugin(e, ["redis"], "redis")
+ base.require_plugin(e, "redis")
import json
import logging
diff --git a/burr/integrations/persisters/postgresql.py b/burr/integrations/persisters/postgresql.py
index 051aacab..b3263b6b 100644
--- a/burr/integrations/persisters/postgresql.py
+++ b/burr/integrations/persisters/postgresql.py
@@ -3,7 +3,7 @@ from burr.integrations import base
try:
import psycopg2
except ImportError as e:
- base.require_plugin(e, ["psycopg2"], "postgresql")
+ base.require_plugin(e, "postgresql")
import json
import logging
diff --git a/burr/integrations/streamlit.py b/burr/integrations/streamlit.py
index 2cba0b67..d734aae3 100644
--- a/burr/integrations/streamlit.py
+++ b/burr/integrations/streamlit.py
@@ -16,7 +16,6 @@ try:
except ImportError as e:
require_plugin(
e,
- ["streamlit", "graphviz", "matplotlib"],
"streamlit",
)
diff --git a/burr/tracking/client.py b/burr/tracking/client.py
index f57d7087..fa3c33d0 100644
--- a/burr/tracking/client.py
+++ b/burr/tracking/client.py
@@ -64,7 +64,6 @@ try:
except ImportError as e:
require_plugin(
e,
- ["pydantic"],
"tracking-client",
)
diff --git a/burr/tracking/common/models.py b/burr/tracking/common/models.py
index 4f13c84a..1f4622ab 100644
--- a/burr/tracking/common/models.py
+++ b/burr/tracking/common/models.py
@@ -12,7 +12,6 @@ try:
except ImportError as e:
require_plugin(
e,
- ["pydantic"],
"tracking",
)
diff --git a/burr/tracking/s3client.py b/burr/tracking/s3client.py
index 61657799..d59f2d7e 100644
--- a/burr/tracking/s3client.py
+++ b/burr/tracking/s3client.py
@@ -34,7 +34,6 @@ try:
except ImportError as e:
require_plugin(
e,
- ["boto3"],
"tracking-s3",
)
diff --git a/docs/getting_started/install.rst b/docs/getting_started/install.rst
index b29502c8..78af476d 100644
--- a/docs/getting_started/install.rst
+++ b/docs/getting_started/install.rst
@@ -2,7 +2,7 @@
Installing
==========
-Burr itself requires almost no dependencies. Every *extra*/*plugin* is an additional install target.
+Burr itself requires no dependencies. Every *extra*/*plugin* is an additional install target.
We recommend you start with installing the ``start`` target -- this has dependencies necessary to track burr through the UI,
along with a fully built server.
@@ -13,3 +13,12 @@ along with a fully built server.
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.
+
+If you're using poetry, you can't install the ``start`` target directly, due to [this issue](https://github.com/python-poetry/poetry/issues/3369).
+Instead, please install manually using the following command:
+
+.. code-block:: bash
+
+ poetry add loguru "burr[tracking-client,tracking-server,streamlit,graphviz,hamilton]"
+
+This is just the kitchen sink for getting started -- remember, burr is dependency-free/pure python!