Rename FastAPI server to EOS.

Rename FastAPI server to `eos` and FastHTML server to `eosdash`. Make an user easily identify what server is meant. FastAPI and FastHTML are implementation details that may confuse the non-technical user. Signed-off-by: Bobby Noelte <[email protected]>
Akkudoktor-EOS · Jan 9, 2025 · f0218b5 · f0218b5
1 parent d2f6e98
commit f0218b5
Show file tree

Hide file tree

Showing 15 changed files with 130 additions and 134 deletions.
diff --git a/Makefile b/Makefile
@@ -19,8 +19,8 @@ help:
 	@echo "  read-docs    - Read HTML documentation in your browser."
 	@echo "  gen-docs     - Generate openapi.json and docs/_generated/*.""
 	@echo "  clean-docs   - Remove generated documentation.""
-	@echo "  run          - Run FastAPI production server in the virtual environment."
-	@echo "  run-dev      - Run FastAPI development server in the virtual environment (automatically reloads)."
+	@echo "  run          - Run EOS production server in the virtual environment."
+	@echo "  run-dev      - Run EOS development server in the virtual environment (automatically reloads)."
 	@echo "  dist         - Create distribution (in dist/)."
 	@echo "  clean        - Remove generated documentation, distribution and virtual environment."
 
@@ -84,12 +84,12 @@ clean: clean-docs
 	@echo "Deletion complete."
 
 run:
-	@echo "Starting FastAPI server, please wait..."
-	.venv/bin/fastapi run --port 8503 src/akkudoktoreos/server/fastapi_server.py
+	@echo "Starting EOS server, please wait..."
+	.venv/bin/fastapi run --port 8503 src/akkudoktoreos/server/eos.py
 
 run-dev:
-	@echo "Starting FastAPI development server, please wait..."
-	.venv/bin/fastapi dev --port 8503 src/akkudoktoreos/server/fastapi_server.py
+	@echo "Starting EOS development server, please wait..."
+	.venv/bin/fastapi dev --port 8503 src/akkudoktoreos/server/eos.py
 
 # Target to setup tests.
 test-setup: pip-dev

diff --git a/README.md b/README.md
@@ -37,13 +37,13 @@ Finally, start EOS fastapi server:
 Linux:
 
 ```bash
-.venv/bin/fastapi run --port 8503 src/akkudoktoreos/server/fastapi_server.py
+.venv/bin/fastapi run --port 8503 src/akkudoktoreos/server/eos.py
 ```
 
 Windows:
 
 ```
- .venv\Scripts\fastapi run --port 8503 src/akkudoktoreos/server/fastapi_server.py
+ .venv\Scripts\fastapi run --port 8503 src/akkudoktoreos/server/eos.py
 ```
 
 ### Docker

diff --git a/docs/_generated/config.md b/docs/_generated/config.md
@@ -287,12 +287,12 @@
 
 | Name | Type | Read-Only | Default | Description |
 | ---- | ---- | --------- | ------- | ----------- |
-| `server_fastapi_host` | `Optional[pydantic.networks.IPvAnyAddress]` | `rw` | `0.0.0.0` | FastAPI server IP address. |
-| `server_fastapi_port` | `Optional[int]` | `rw` | `8503` | FastAPI server IP port number. |
-| `server_fastapi_startup_server_fasthtml` | `Optional[bool]` | `rw` | `True` | FastAPI server to startup application FastHTML server. |
-| `server_fastapi_verbose` | `Optional[bool]` | `rw` | `False` | Enable debug output |
-| `server_fasthtml_host` | `Optional[pydantic.networks.IPvAnyAddress]` | `rw` | `0.0.0.0` | FastHTML server IP address. |
-| `server_fasthtml_port` | `Optional[int]` | `rw` | `8504` | FastHTML server IP port number. |
+| `server_eos_host` | `Optional[pydantic.networks.IPvAnyAddress]` | `rw` | `0.0.0.0` | EOS server IP address. |
+| `server_eos_port` | `Optional[int]` | `rw` | `8503` | EOS server IP port number. |
+| `server_eos_startup_eosdash` | `Optional[bool]` | `rw` | `True` | EOS server to start EOSdash server. |
+| `server_eos_verbose` | `Optional[bool]` | `rw` | `False` | Enable debug output |
+| `server_eosdash_host` | `Optional[pydantic.networks.IPvAnyAddress]` | `rw` | `0.0.0.0` | EOSdash server IP address. |
+| `server_eosdash_port` | `Optional[int]` | `rw` | `8504` | EOSdash server IP port number. |
 :::
 
 ## Weather Forecast Configuration

diff --git a/docs/_generated/openapi.md b/docs/_generated/openapi.md
@@ -202,17 +202,17 @@ Returns:
 
 **Parameters**:
 
-- `server_fastapi_host` (query, optional): FastAPI server IP address.
+- `server_eos_host` (query, optional): EOS server IP address.
 
-- `server_fastapi_port` (query, optional): FastAPI server IP port number.
+- `server_eos_port` (query, optional): EOS server IP port number.
 
-- `server_fastapi_verbose` (query, optional): Enable debug output
+- `server_eos_verbose` (query, optional): Enable debug output
 
-- `server_fastapi_startup_server_fasthtml` (query, optional): FastAPI server to startup application FastHTML server.
+- `server_eos_startup_eosdash` (query, optional): EOS server to start EOSdash server.
 
-- `server_fasthtml_host` (query, optional): FastHTML server IP address.
+- `server_eosdash_host` (query, optional): EOSdash server IP address.
 
-- `server_fasthtml_port` (query, optional): FastHTML server IP port number.
+- `server_eosdash_port` (query, optional): EOSdash server IP port number.
 
 - `weatherimport_file_path` (query, optional): Path to the file to import weather data from.
 

diff --git a/docs/develop/getting_started.md b/docs/develop/getting_started.md
@@ -38,13 +38,13 @@ Start the EOS fastapi server:
 
      .. code-block:: powershell
 
-        .venv\Scripts\fastapi run src/akkudoktoreos/server/fastapi_server.py
+        .venv\Scripts\fastapi run src/akkudoktoreos/server/eos.py
 
   .. tab:: Linux
 
      .. code-block:: bash
 
-        .venv/bin/fastapi run src/akkudoktoreos/server/fastapi_server.py
+        .venv/bin/fastapi run src/akkudoktoreos/server/eos.py
 
 ```