Remove streamlit app

README.md

@@ -12,6 +12,11 @@ The Skypro reporting tool collates data to documents and analyse real-world perf
 This tool is run on the command line using `skypro report`.
 See `src/skypro/commands/report/README.md` for more information.
 
+## Reporting web app - DEPRECATED
+The Skypro reporting web app makes reporting results accessible to non-cli users. It is now deprecated.
+This is run using Streamlit.
+See `src/skypro/reporting_webapp/README.md` for more information.
+
 ## Rates and energy flows
 Information about the costs and revenues associated with using power are fundamental to the codebase and a high-level understanding of how they are modelled is important for interpreting results.
 See `src/skypro/common/rates/README.md` for a background on how rates and energy flows are modelled in the codebase.

pyproject.toml

@@ -21,6 +21,7 @@ sqlalchemy = "^2.0.37"
 psycopg2-binary = "^2.9.10"
 requests = "^2.32.3"
 arrow = "^1.3.0"
+streamlit = "^1.45.1"
 
 [[tool.poetry.source]]
 name = "testpypi"

src/skypro/reporting_webapp/README.md

@@ -0,0 +1,21 @@
+# DEPRECATED - Skypro reporting web app
+
+This is a Streamlit web app that makes the reporting functionality available over a web front end.
+
+The app supports different 'scenarios'- each of which have an associated reporting configuration file.
+This is useful because it allows multiple microgrids to be reviewed from the same app.
+It also means you can compare multiple Supplier arrangements, for example, you could have a scenario where P395 is active, and one where it's not.
+
+The app calls into the main reporting code (using the appropriate configuration file) and visualises the results.
+
+![screenshot](../../../docs/reporting_webapp_screenshot.png)
+
+## Usage
+
+The Streamlit app can be launched with:
+```
+SKIP_PASSWORD=true CONFIG_FILE=src/skypro/reporting_webapp/example_config.yaml streamlit run src/skypro/reporting_webapp/main.py
+```
+This should open a window in your default browser.
+This example configuration uses the integration testing fixtures which only have data available for August 2024 - so that is the only month that works in this example!
+

src/skypro/reporting_webapp/example_config.yaml

@@ -0,0 +1,5 @@
+vars: {}
+
+reportScenarios:
+  "Some scenario":
+    config: "./src/tests/integration/fixtures/reporting/config.yaml"