Merge pull request #60 from ghost-in-moss/version/0.1.5

relase: version 0.1.5

Author: thirdgerb

RELEASES.md

@@ -5,6 +5,11 @@
 
 first release version.
 
+## v0.1.5
+
+* `ghostos web` add `--src` option, load the directory to python path, make sure can import relative packages.
+* fix `.ghostos.yml` with relative path, in case share project with absolute local filepath.
+
 ## v0.1.4
 
 add llm driver supporting openai azure api.

ghostos/bootstrap.py

@@ -110,14 +110,10 @@ def find_workspace_dir() -> str:
 
 class BootstrapConfig(BaseModel):
     workspace_dir: str = Field(
-        default_factory=find_workspace_dir,
-        description="ghostos workspace directory",
+        default="app",
+        description="ghostos relative workspace directory",
     )
     dotenv_file_path: str = Field(".env", description="ghostos workspace .env file")
-    ghostos_dir: str = Field(
-        default=dirname(dirname(__file__)),
-        description="ghostos source code directory",
-    )
     workspace_configs_dir: str = Field(
         "configs",
         description="ghostos workspace relative path for configs directory",
@@ -129,19 +125,34 @@ class BootstrapConfig(BaseModel):
 
     __from_file__: str = ""
 
+    @staticmethod
+    def abs_ghostos_dir() -> str:
+        return dirname(dirname(__file__))
+
+    def abs_workspace_dir(self) -> str:
+        from os.path import abspath, exists, isdir
+        app_dir = abspath(self.workspace_dir)
+        if exists(app_dir) and isdir(app_dir):
+            return app_dir
+        return find_workspace_dir()
+
     def abs_runtime_dir(self) -> str:
-        return join(self.workspace_dir, "runtime")
+        workspace_dir = self.abs_workspace_dir()
+        return join(workspace_dir, "runtime")
 
     def abs_asserts_dir(self) -> str:
-        return join(self.workspace_dir, "assets")
+        workspace_dir = self.abs_workspace_dir()
+        return join(workspace_dir, "assets")
 
     def env_file(self) -> str:
-        return join(self.workspace_dir, self.dotenv_file_path)
+        workspace_dir = self.abs_workspace_dir()
+        return join(workspace_dir, self.dotenv_file_path)
 
     def env_example_file(self) -> str:
-        return join(self.workspace_dir, ".example.env")
+        workspace_dir = self.abs_workspace_dir()
+        return join(workspace_dir, ".example.env")
 
-    def save(self, dir_path: str = None):
+    def save(self, dir_path: str = None) -> str:
         from ghostos.helpers import yaml_pretty_dump
         if dir_path is None:
             filename = join(abspath(".ghostos.yml"))
@@ -150,6 +161,7 @@ def save(self, dir_path: str = None):
         content = yaml_pretty_dump(self.model_dump())
         with open(filename, "w") as f:
             f.write(content)
+        return filename
 
 
 def get_bootstrap_config(local: bool = True) -> BootstrapConfig:
@@ -273,7 +285,7 @@ def default_application_providers(
         DefaultLoggerProvider(),
         # --- workspace --- #
         BasicWorkspaceProvider(
-            workspace_dir=config.workspace_dir,
+            workspace_dir=config.abs_workspace_dir(),
             configs_path=config.workspace_configs_dir,
             runtime_path=config.workspace_runtime_dir,
         ),
@@ -327,7 +339,7 @@ def make_app_container(
     if bootstrap_conf is None:
         bootstrap_conf = get_bootstrap_config(local=True)
     workspace_dir = bootstrap_conf.workspace_dir
-    if workspace_dir.startswith(bootstrap_conf.ghostos_dir):
+    if workspace_dir.startswith(bootstrap_conf.abs_ghostos_dir()):
         warn(
             f"GhostOS workspace dir is not found, better run `ghostos init` at first."
             f"Currently using `{workspace_dir}` as workspace."

ghostos/scripts/cli/__init__.py

@@ -17,12 +17,19 @@ def main():
 
 @main.command("web")
 @click.argument("python_file_or_module")
-def start_streamlit_web(python_file_or_module: str):
+@click.option("--src", "-s", default=".", show_default=True)
+def start_streamlit_web(python_file_or_module: str, src: str):
     """
     turn a python file or module into a streamlit web agent
     """
     from ghostos.scripts.cli.run_streamlit_app import start_ghost_app
     from ghostos.scripts.cli.utils import find_ghost_by_file_or_module
+    import sys
+    from os.path import abspath
+    if src:
+        # add source path to system so to import the source code.
+        sys.path.append(abspath(src))
+
     ghost_info, module, filename, is_temp = find_ghost_by_file_or_module(python_file_or_module)
     start_ghost_app(ghost_info, module.__name__, filename, is_temp)
 
@@ -44,7 +51,11 @@ def start_web_config():
     """
     from ghostos.scripts.cli.run_streamlit_app import start_streamlit_prototype_cli
     from ghostos.bootstrap import get_bootstrap_config
-    start_streamlit_prototype_cli("run_configs.py", "", get_bootstrap_config().workspace_dir)
+    start_streamlit_prototype_cli(
+        "run_configs.py",
+        "",
+        get_bootstrap_config().abs_workspace_dir(),
+    )
 
 
 @main.command("clear-runtime")
@@ -86,18 +97,19 @@ def init_app(path: str):
     ))
 
     conf = get_bootstrap_config(local=False)
+    cwd = getcwd()
     result = Prompt.ask(
-        f"\n>> will init ghostos workspace at `{getcwd()}`. input directory name:",
+        f"\n>> will init ghostos workspace at `{cwd}`. input directory name:",
         default="app",
     )
-    source_dir = join(conf.ghostos_dir, "ghostos/app")
+    source_dir = app_stub_dir()
     real_workspace_dir = abspath(result)
     console.print("start to init ghostos workspace")
     copy_workspace(source_dir, real_workspace_dir)
     console.print("ghostos workspace copied")
-    conf.workspace_dir = real_workspace_dir
-    conf.save(real_workspace_dir)
-    console.print("save .ghostos.yml")
+    conf.workspace_dir = result
+    saved_file = conf.save(cwd)
+    console.print(f"save .ghostos.yml to {saved_file}")
     console.print(Panel(Markdown(f"""
 Done create workspace!
 

ghostos/scripts/cli/run_streamlit_app.py

@@ -44,7 +44,7 @@ def get_config_flag_options(workspace_dir: str) -> List[str]:
 def start_ghost_app(ghost_info: GhostInfo, modulename: str, filename: str, is_temp: bool):
     # path
     conf = get_bootstrap_config(local=True)
-    workspace_dir = conf.workspace_dir
+    workspace_dir = conf.abs_workspace_dir()
     args = RunGhostChatApp(
         modulename=modulename,
         filename=filename,
@@ -53,7 +53,7 @@ def start_ghost_app(ghost_info: GhostInfo, modulename: str, filename: str, is_te
         ghost_meta=ghost_info.ghost,
         context_meta=ghost_info.context,
     )
-    start_streamlit_prototype_cli("run_ghost_chat.py", args.model_dump_json(), conf.workspace_dir)
+    start_streamlit_prototype_cli("run_ghost_chat.py", args.model_dump_json(), workspace_dir)
 
 
 def start_streamlit_prototype_cli(filename: str, cli_args: str, workspace_dir: str):

ghostos/scripts/copy_workspace.py

@@ -35,7 +35,7 @@ def main():
     )
     parsed = parser.parse_args(sys.argv[1:])
     target_dir = abspath(parsed.target)
-    copy_workspace(conf.workspace_dir, target_dir)
+    copy_workspace(conf.abs_workspace_dir(), target_dir)
     print(f"Copied skeleton files to {target_dir}")
 
 

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "ghostos"
-version = "0.1.4"
+version = "0.1.5"
 description = "A framework offers an operating system simulator with a Python Code Interface for AI Agents"
 authors = ["zhuming <thirdgerb@gmail.com>", "Nile Zhou <nilezhou123@gmail.com>"]
 license = "MIT"