multi page setup and single need viewer

Author: danwos

.envrc

@@ -0,0 +1 @@
+source .venv/bin/activate

sphinx_needs_viewer/viewer.py sphinx_needs_viewer/pages/1_Needs_Viewer.py

@@ -0,0 +1,57 @@
+import json
+import urllib.request
+
+import streamlit as st
+from streamlit_agraph import agraph, Node, Edge, Config
+
+from sphinx_needs_viewer.util  import get_need, get_needs_ids
+
+NEEDS_URL = "https://sphinx-needs.readthedocs.io/en/latest/needs.json"
+
+@st.cache_data
+def get_needs_data(needs_url):  # noqa: D103
+    with urllib.request.urlopen(needs_url) as url:  # noqa: S310
+        return json.load(url)
+    
+# Page config
+st.set_page_config(
+    page_title="Single Need Viewer",
+    page_icon="📦",
+    layout="wide",
+    initial_sidebar_state="expanded",
+    menu_items={
+        "Report a bug": "https://github.com/useblocks/sphinx-needs-viewer",
+    },
+)
+
+needs_url = st.text_input("**needs.json URL**", NEEDS_URL)
+need_ids = get_needs_ids(needs_url)
+url_params = st.query_params
+selected_id_index = 0
+if "id" in url_params:
+    selectd_id = url_params['id']
+    try:
+        selected_id_index = list(need_ids).index(selectd_id)
+    except ValueError:
+        selected_id_index = 0 # ID not found
+
+need_id = option = st.selectbox(
+    "Needs ID",need_ids, index=selected_id_index)
+need = get_need(needs_url, need_id)
+
+
+if not need:
+    st.write(f"Need with ID {need_id}  ot found")
+else:
+    st.markdown(f"""
+## {need["id"]}: {need["title"]}
+status: **{need["status"]}**
+
+doc: **{need["docname"]}{need["doctype"]}**
+
+link: https://sphinx-needs.readthedocs.io/en/latest/{need["docname"]}.html#{need["id"]}
+
+{need["description"]}
+""")
+
+    st.dataframe(need, use_container_width=True)

sphinx_needs_viewer/pages/2_Single_Need_Viewer.py

@@ -0,0 +1,33 @@
+import json
+import urllib.request
+import sys
+
+import streamlit as st
+
+@st.cache_data
+def get_needs_data(needs_url):  # noqa: D103 
+    try:
+        with urllib.request.urlopen(needs_url) as url:  # noqa: S310
+            return json.load(url)
+    except Exception:
+        sys.exit(0)
+
+@st.cache_data
+def get_prepared_needs(needs_url, max_needs=20):
+    needs_raw_data = get_needs_data(needs_url)
+    needs_data = needs_raw_data["versions"]["2.1.0"]["needs"]
+    needs_data_reduced = {x['id']:x for x in list(needs_raw_data["versions"]["2.1.0"]["needs"].values())[0:max_needs]}
+    return needs_data_reduced
+
+@st.cache_data
+def get_need(needs_url, need_id):
+    needs_raw_data = get_needs_data(needs_url)
+    needs_data = needs_raw_data["versions"]["2.1.0"]["needs"]
+    try:
+        return needs_data[need_id]
+    except KeyError:
+        return False
+    
+def get_needs_ids(needs_url):
+    needs_raw_data = get_needs_data(needs_url)
+    return needs_raw_data["versions"]["2.1.0"]["needs"].keys()

sphinx_needs_viewer/util.py

@@ -0,0 +1,10 @@
+import streamlit as st
+
+st.set_page_config(
+    page_title="Hello",
+    page_icon="👋",
+)
+
+st.write("# Welcome to Streamlit! 👋")
+
+st.sidebar.success("Select a demo above.")