Skip to content

Commit ee66029

Browse files
committed
description add
1 parent ebc547a commit ee66029

1 file changed

Lines changed: 15 additions & 1 deletion

File tree

README.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,12 @@ pip install -r requirements/base.txt # for base package
1616
pip install -r requirements/streamlit.txt # For Streamlit UI (browser)
1717
pip install -r requirements/kivy.txt # For Kivy UI (desktop)
1818

19+
# Or install by package extras
20+
pip install . # core computation/storage package
21+
pip install .[api] # FastAPI backend for Tauri/web frontends
22+
pip install .[streamlit] # Streamlit UI + chart rendering
23+
pip install .[kivy] # Kivy desktop UI + chart rendering
24+
1925
# 3. Run the application
2026
python3 -m module --streamlit # Streamlit UI (browser)
2127
python3 -m module --kivy # Kivy UI (desktop)
@@ -27,6 +33,15 @@ For detailed setup instructions, troubleshooting, and advanced options, see the
2733

2834
You can also explore [Documentation](./docs/README.md) to see more detailed overview.
2935

36+
## Suggested Runtime Split
37+
38+
- `core`: install `pip install .` for computation, workspace, and storage helpers
39+
- `api`: install `pip install .[api]` for a FastAPI sidecar/backend without UI dependencies
40+
- `streamlit`: install `pip install .[streamlit]` for the browser UI
41+
- `kivy`: install `pip install .[kivy]` for the native Python desktop UI
42+
43+
For a `React frontend from Figma + FastAPI backend + Tauri packaging` setup, prefer `core + api` and keep the `ui_*` modules as optional developer-only frontends.
44+
3045
## How it works
3146

3247
All the heavy lifting is made by a module [g-battaglia/kerykeion](https://github.com/g-battaglia/kerykeion), manipulation layer over [astrorigin/pyswisseph](https://github.com/astrorigin/pyswisseph) (also known as [swiss ephemerides](https://www.astro.com/swisseph/swephinfo_e.htm)), thus the license is inherited (GNU Affero GPL v3.0). Other dependencies are mentioned in the [requirements file](./requirements/base.in).
@@ -193,4 +208,3 @@ User Input
193208
194209
Aspects are computed on demand from positions (not stored by default).
195210
```
196-

0 commit comments

Comments
 (0)