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.

Adds to install page about different targets (#423)

Stefan Krawczykf45f99d937b8
diff --git a/docs/getting_started/install.rst b/docs/getting_started/install.rst
index 33184b22..7458a2cd 100644
--- a/docs/getting_started/install.rst
+++ b/docs/getting_started/install.rst
@@ -22,3 +22,137 @@ Instead, please install manually using the following command:
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!
+
+------------------------------------
+Description of different targets
+------------------------------------
+
+.. code-block:: bash
+
+ pip install 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.
+
+.. code-block:: bash
+
+ pip install "burr[cli]"
+
+This installs the dependencies to run the burr CLI, i.e. `burr --help`.
+
+.. code-block:: bash
+
+ pip install "burr[developer]"
+
+This installs all the dependencies for developing locally.
+
+
+.. code-block:: bash
+
+ pip install "burr[documentation]"
+
+This installs the dependencies to build the documentation.
+
+.. code-block:: bash
+
+ pip install "burr[examples]"
+
+This installs the dependencies for the examples.
+
+
+.. code-block:: bash
+
+ pip install "burr[graphviz]"
+
+This installs the dependencies to visualize the graph.
+
+.. code-block:: bash
+
+ pip install "burr[hamilton]"
+
+This installs the dependencies for Hamilton.
+
+.. code-block:: bash
+
+ pip install "burr[haystack]"
+
+This installs the dependencies for Haystack.
+
+.. code-block:: bash
+
+ pip install "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]"
+
+This installs the dependencies for using OpenTelemetry with Burr.
+
+.. code-block:: bash
+
+ pip install "burr[postgresql]"
+
+This installs the dependencies for PostgreSQL.
+
+.. code-block:: bash
+
+ pip install "burr[pydantic]"
+
+This installs the dependencies for Pydantic.
+
+.. code-block:: bash
+
+ pip install "burr[redis]"
+
+This installs the dependencies for Redis.
+
+.. code-block:: bash
+
+ pip install "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]"
+
+This installs the dependencies for Streamlit.
+
+.. code-block:: bash
+
+ pip install "burr[tests]"
+
+This installs the dependencies for running unit tests.
+
+.. code-block:: bash
+
+ pip install "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]"
+
+This installs the client dependencies for tracking to a filesystem.
+
+.. code-block:: bash
+
+ pip install "burr[tracking-client-s3]"
+
+This installs the client dependencies for tracking to S3.
+
+.. code-block:: bash
+
+ pip install "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]"
+
+This installs the server dependencies for running the UI off a filesystem.