feat: initialize documentation directory

Author: maciejmajek

src/rai_whoami/README.md

@@ -23,7 +23,13 @@ This embodiment info is then used to create a system prompt for LLM-based agents
 
 ### Directory Structure
 
-Prepare your robot documentation directory as follows:
+Initialize the documentation directory:
+
+```bash
+initialize-docs documentation_dir
+```
+
+Populate your robot documentation directory:
 
 ```
 documentation_dir/
@@ -37,7 +43,7 @@ documentation_dir/
 To generate the system prompt from your documentation directory:
 
 ```bash
-python src/rai_whoami/rai_whoami/build_whoami.py documentation_dir [--output_dir output_dir] [--build-vector-db]
+build-whoami documentation_dir [--output_dir output_dir] [--build-vector-db]
 ```
 
 Generated files will be saved in the `output_dir / generated` directory or `documentation_dir / generated` if not specified.

src/rai_whoami/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "rai_whoami"
-version = "0.0.4"
+version = "0.0.5"
 description = "Package to extract embodiment information from robot documentation"
 authors = ["Maciej Majek <[email protected]>"]
 readme = "README.md"
@@ -24,6 +24,7 @@ pypdf = "^5.4.0"
 
 [tool.poetry.scripts]
 build-whoami = "rai_whoami.build_whoami:main"
+initialize-docs = "rai_whoami.initialize_docs_directory:main"
 
 
 [build-system]

src/rai_whoami/rai_whoami/initialize_docs_directory.py

@@ -0,0 +1,51 @@
+# Copyright (C) 2025 Robotec.AI
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#         http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+import argparse
+import os
+from pathlib import Path
+
+SUBDIRECTORIES = [
+    "images",
+    "documentation",
+    "urdf",
+]
+
+
+def initialize_docs_directory(args: argparse.Namespace) -> None:
+    documentation_dir = Path(args.documentation_dir)
+    if os.path.exists(documentation_dir):
+        print(
+            f"Directory {documentation_dir} already exists. Remove it or use different folder."
+        )
+        return
+
+    os.makedirs(documentation_dir)
+    print(f"Initialized documentation directory at {documentation_dir}")
+    for subdirectory in SUBDIRECTORIES:
+        os.makedirs(documentation_dir / subdirectory)
+        print(
+            f"Initialized subdirectory {subdirectory} at {documentation_dir / subdirectory}"
+        )
+
+
+def main():
+    parser = argparse.ArgumentParser()
+    parser.add_argument("documentation_dir", type=Path)
+    args = parser.parse_args()
+    initialize_docs_directory(args)
+
+
+if __name__ == "__main__":
+    main()