db_query / documentations /import_physical_db_doc.py
DavMelchi's picture
feat: improve streamlit docs and clean navigation icons
4d0d437
import streamlit as st
st.markdown(
"""
# Physical Database Verification Documentation
## 1. Objective
Display the current physical database reference used by the app.
## 2. When to use this tool
Use this page when you need to inspect the latest physical database content before validation tasks.
## 3. Input files and accepted formats
No user upload is required.
The page reads local file:
- `physical_db/physical_database.csv`
## 4. Required columns/fields
No fixed schema is enforced by this page. It displays the CSV as-is.
## 5. Step-by-step usage
1. Open `Apps > Physical Database Verification`.
2. Click `Show actual physical database`.
3. Review the displayed table.
## 6. Outputs generated
- data table rendered from `physical_database.csv`
## 7. Frequent errors and fixes
- File not found warning.
- Fix: ensure `physical_db/physical_database.csv` exists in repository.
- Empty table.
- Fix: verify CSV has data rows and valid delimiter.
- Parsing issue.
- Fix: confirm CSV encoding and structure.
## 8. Minimal reproducible example
- Input: existing `physical_db/physical_database.csv`
- Action: click show button.
- Expected result: full CSV displayed as Streamlit dataframe.
## 9. Known limitations
- Read-only page (no edit/upload flow).
- No filtering/export controls in current implementation.
- Depends entirely on local file availability.
## 10. Version and update date
- Documentation version: 1.0
- Last update: 2026-02-23
"""
)