Docs/cli docs (#138)

* feat: add a global starfyre import way

* add js

* add js files

* complete the feature

* fix formatting

* docs: update starfyre docs

README.md

@@ -30,7 +30,7 @@ A sample project is hosted on [GitHub](https://github.com/sansyrox/first-starfyr
 To create an application
 
 ```bash
-python3 -m starfyre --create="my-app"
+starfyre --create="my-app"
 ```
 
 It will use the [create-starfyre-app](https://github.com/sparckles/create-starfyre-app) as the template to create a new project.
@@ -49,7 +49,7 @@ def message():
   return "World"
 
 ---client
-import js
+from starfyre import js
 
 def handle_click():
   js.console.log("Hello World")
@@ -172,9 +172,9 @@ Fireworks = "https://cdn.jsdelivr.net/npm/[email protected]/+esm"
 You can specify the dependencies using the following commands:
 
 ```bash
-python3 -m starfyre --add-pyxide-package="package-name"
-python3 -m starfyre --add-server-package="package-name"
-python3 -m starfyre --add-js-module="module-name" --as="alias"
+starfyre --add-pyxide-package="package-name"
+starfyre --add-server-package="package-name"
+starfyre --add-js-module="module-name" --as="alias"
 ```
 
 

docs/README.md

@@ -30,7 +30,7 @@ A sample project is hosted on [GitHub](https://github.com/sansyrox/first-starfyr
 To create an application
 
 ```bash
-python3 -m starfyre --create="my-app"
+starfyre --create="my-app"
 ```
 
 It will use the [create-starfyre-app](https://github.com/sparckles/create-starfyre-app) as the template to create a new project.
@@ -46,7 +46,7 @@ def message():
   return "World"
 
 ---client
-import js
+from starfyre import js
 
 def handle_click():
   js.console.log("Hello World")
@@ -169,9 +169,9 @@ Fireworks = "https://cdn.jsdelivr.net/npm/[email protected]/+esm"
 You can specify the dependencies using the following commands:
 
 ```bash
-python3 -m starfyre --add-pyxide-package="package-name"
-python3 -m starfyre --add-server-package="package-name"
-python3 -m starfyre --add-js-module="module-name" --as="alias"
+starfyre --add-pyxide-package="package-name"
+starfyre --add-server-package="package-name"
+starfyre --add-js-module="module-name" --as="alias"
 ```
 
 

docs/compiler.md

@@ -10,7 +10,7 @@ The compiler is a core component of Starfyre that facilitates the conversion of
 
 - **Exception Handling**: The compiler introduces new exception classes to handle specific scenarios, such as the absence of `__init__.fyre` or conflicts due to the use of an `index.fyre` file.
 
-- **Parsing `.fyre` Files**: Each `.fyre` file is parsed to extract `Python`, `CSS`, `PyML`, `JS`, and client-side Python components. These components are then transpiled into intermediate representations.
+- **Parsing `.fyre` Files**: Each `.fyre` file is parsed to extract `Python`, `CSS`, `Pyxide`, `JS`, and client-side Python components. These components are then transpiled into intermediate representations.
 
 - **IR Generation**: The transpiled components are combined to generate an intermediate representation (IR) of the `.fyre` file's content.
 
@@ -19,7 +19,7 @@ The compiler is a core component of Starfyre that facilitates the conversion of
 ## Transpiler Details
 The transpiler takes the intermediate representation (IR) of `.fyre` files, which are `.py` files that capture the abstracted structure of the original `.fyre` code, and generates executable Python code. It accomplishes this through the following steps:
 
-1) **Extracting IR Components**: The transpiler extracts `Python`, `CSS`, `PyML`, `JS`, and client-side Python components from the IR.
+1) **Extracting IR Components**: The transpiler extracts `Python`, `CSS`, `Pyxide`, `JS`, and client-side Python components from the IR.
 
 2) **Creating Python Code**: Based on the extracted components, the transpiler creates Python code that utilizes the `create_component` and `hydrate` functions appropriately. It also handles the special case of the `__init__.fyre` file.
 

docs/component_parser.md

@@ -1,10 +1,10 @@
 # Component Parser in Starfyre
 
 ### Introduction
-This document provides an overview of the `ComponentParser` in Starfyre. This crucial feature ensures the correct parsing of PyML structure, validates tags, and maintains proper tag order in Starfyre components.
+This document provides an overview of the `ComponentParser` in Starfyre. This crucial feature ensures the correct parsing of Component structure, validates tags, and maintains proper tag order in Starfyre components.
 
 ### Feature Overview
-The `ComponentParser` is responsible for parsing `PyML` structures and ensuring that they adhere to specified rules. It plays a significant role in validating tags, their attributes, and their order within the component.
+The `ComponentParser` is responsible for parsing `Component` structures and ensuring that they adhere to specified rules. It plays a significant role in validating tags, their attributes, and their order within the component.
 
 ### Implementation Details
 The `ComponentParser` in Starfyre is implemented as a class inheriting the `HTMLParser`. Here's an overview of its functionality:
@@ -21,30 +21,30 @@ class ComponentParser(HTMLParser):
     def handle_data(self, data):
         # Logic for handling data...
 
-    # Additional methods for processing PyML content...
+    # Additional methods for processing Component content...
 
 ```
 ### Event Handling and Props
-The parser identifies event handlers and props within PyML tags, ensuring they are correctly associated with their respective components.
+The parser identifies event handlers and props within component tags, ensuring they are correctly associated with their respective components.
 
 ### Custom Components
-When encountering custom components in PyML, the parser correctly integrates them into the component hierarchy. This ensures that custom components are properly recognized and processed.
+When encountering custom components, the parser correctly integrates them into the component hierarchy. This ensures that custom components are properly recognized and processed.
 
 ### Error Handling
 The Component Parser performs thorough error checking, ensuring that tags are valid and in the correct order. When an issue is detected, it raises an exception with detailed information, including the component name and line number.
 
 ### Usage Example
 Here's an example of how the Component Parser is utilized within Starfyre:
 
-1) Create a `PyML` file for your Starfyre component.
+1) Create a `.fyre` file for your Starfyre component.
 
-2) Define your component structure using `PyML` syntax.
+2) Define your component structure using `.fyre` syntax.
 
-3) Use the `ComponentParser` class to parse the `PyML` content of your component.
+3) Use the `ComponentParser` class to parse the `.fyre` content of your component.
 
 4) Handle any exceptions raised during parsing, including the `UnknownTagError`.
 
 5) Utilize the parsed component structure to generate dynamic content within your Starfyre application.
 
 ### Conclusion
-The Component Parser is a critical part of Starfyre, ensuring the correct parsing and validation of PyML structures. With the introduction of the UnknownTagError and improved error reporting, developers can more easily identify and resolve issues within their components.
+The Component Parser is a critical part of Starfyre, ensuring the correct parsing and validation of Pyxide structures. With the introduction of the UnknownTagError and improved error reporting, developers can more easily identify and resolve issues within their components.

starfyre/dist_builder.py

@@ -17,11 +17,13 @@ def write_python_client_file(path: Path):
     dist_path.mkdir(exist_ok=True)
     with pkg_resources.path("starfyre.js", "store.py") as store_py, pkg_resources.path(
         "starfyre.js", "dom_helpers.py"
-    ) as dom_helpers:
+    ) as dom_helpers, pkg_resources.path("starfyre.js", "starfyre.py") as starfyre:
         store_path = dist_path / "store.py"
         shutil.copy(str(store_py), str(store_path))
         dom_helpers_path = dist_path / "dom_helpers.py"
         shutil.copy(str(dom_helpers), str(dom_helpers_path))
+        starfyre_path = dist_path / "starfyre.py"
+        shutil.copy(str(starfyre), str(starfyre_path))
 
 
 def generate_html_pages(file_routes, project_dir: Path):
@@ -136,6 +138,7 @@ def copy_starfyre_config(project_dir: Path):
 
     pyscript_data = {}
     pyscript_data["packages"] = data["pyxide_packages"]
+    pyscript_data["files"] = {"./starfyre.py": "./starfyre.py"}
 
     js_modules_main = {}
     for js_module in data["js_modules"]:

starfyre/js/dom_helpers.py

@@ -1,5 +1,5 @@
-import ujson as json
 import js
+import ujson as json
 
 
 def is_listener(name):

starfyre/js/starfyre.py

@@ -0,0 +1,6 @@
+import js
+from pyscript import display, document, window
+
+websocket = js.WebSocket
+
+__all__ = ["websocket", "document", "window", "js", "display"]

starfyre/js/store.py

@@ -2,8 +2,7 @@
 
 import random
 
-import js
-
+from starfyre import js
 
 store = GLOBAL_STORE
 observers = GLOBAL_OBSERVERS

test_application/build.sh

@@ -1,3 +1,3 @@
 #!/bin/sh
 
-python3 -m starfyre --build --path="."
+starfyre --build --path="."

test_application/pages/__init__.fyre

@@ -16,7 +16,7 @@ def handle_on_click(e):
 
 
 from pyscript.js_modules import Fireworks
-from pyscript import document
+from starfyre import document
 
 #container = document.querySelector("[data-pyxide-id='root']")
 #f = Fireworks.Fireworks.new(container)

test_application/serve.sh

@@ -1,3 +1,3 @@
 #!/bin/sh
 
-python3 -m starfyre --serve --path="."
+starfyre --serve --path="."

test_application/starfyre_config.toml

@@ -4,3 +4,4 @@ server_packages = []
 [js_modules]
 is_odd = "https://cdn.jsdelivr.net/npm/[email protected]/+esm"
 Fireworks = "https://cdn.jsdelivr.net/npm/[email protected]/+esm"
+

test_application/store.fyre

@@ -1,7 +1,7 @@
 ---client 
 
-from pyscript import display
-from pyscript import window, document
+from starfyre import display
+from starfyre import window, document
 
 
 ---