From e4da2f5de99aca9b51721237fdd5c8e95a791f74 Mon Sep 17 00:00:00 2001 From: elijahbenizzy Date: Fri, 23 Feb 2024 11:44:24 -0800 Subject: [PATCH] Fixes README to install the server dependencies Also notes that this is not needed for the full thing. --- README.md | 15 +++++++++------ pyproject.toml | 5 ++++- 2 files changed, 13 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 8abf81b65..b5c19af97 100644 --- a/README.md +++ b/README.md @@ -41,21 +41,24 @@ but realized that it has a wide array of applications and decided to release it. To get started, install from `pypi`, using your favorite package manager: -``` -pip install burr +```bash +pip install "burr[start]" ``` +This includes the dependencies for the tracking server (see next step) -- alternatively if you want the core library only then just run `pip install burr` Then, run the server and check out the demo projects: -``` -burr +```bash +$ burr + +2024-02-23 11:43:21.249 | INFO | burr.cli.__main__:run_server:88 - Starting server on port 7241 ``` -This will open up a browser window with a few demo projects preloaded for you to play with. +This will start a server and open up a browser window with a few demo projects preloaded for you to play with. Next, see the documentation for [getting started](https://studious-spork-n8kznlw.pages.github.io/getting_started/simple-example.html), and follow the example. Then read through some of the concepts and write your own application! # Contributing -We welcome contributors! To get started on developing, see the [developer-facing docs]([documentation](https://studious-spork-n8kznlw.pages.github.io/contributing))_ +We welcome contributors! To get started on developing, see the [developer-facing docs](https://studious-spork-n8kznlw.pages.github.io/contributing). diff --git a/pyproject.toml b/pyproject.toml index 65e7ca226..912830b80 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -72,6 +72,10 @@ tracking = [ "loguru", ] +start = [ + "burr[tracking]" +] + # just install everything for developers developer = [ "burr[streamlit]", @@ -79,7 +83,6 @@ developer = [ "burr[tracking]", "burr[tests]", "burr[documentation]", - "loguru", # I love loguru TBH, but not for any prod stuff "build", "twine", "pre-commit",