separated gui installation to be optional

rpakishore · Mar 7, 2024 · 71efdd1 · 71efdd1
1 parent c6f3b00
commit 71efdd1
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -81,15 +81,28 @@ Clone repo and Install with flit
 git clone https://github.com/rpakishore/ak_sap.git
 cd  ak_sap
 pip install flit
-flit install --deps production
 ```
 
+- If you want just the base package:
+
+  ```bash
+  flit install --deps production
+  ```
+
+- Alternatively, if you also want to include the optional streamlit gui:
+
+  ```bash
+  flit install --deps production --extras gui
+  ```
+
 ##### 2.2.1.3. Install from Pypi release
 
 ```bash
 pip install ak_sap
 ```
 
+Note: The Pypi version does not ship with the optional streamlit gui
+
 #### 2.2.2. Development
 
 Download the git and install via flit

diff --git a/pyproject.toml b/pyproject.toml
@@ -25,7 +25,10 @@ dev = [
     "ipywidgets",
     "pandasgui",
     "line-profiler",
-    "pytest==7.4.3",
+    "pytest==7.4.3"
+]
+
+gui = [
     "streamlit==1.31.0",
     "hilti_profis==0.0.3"
 ]