fastled 1.1.38__tar.gz → 1.1.39__tar.gz

{fastled-1.1.38/src/fastled.egg-info → fastled-1.1.39}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: fastled
-Version: 1.1.38
+Version: 1.1.39
 Summary: FastLED Wasm Compiler
 Home-page: https://github.com/zackees/fastled-wasm
 Maintainer: Zachary Vorhies
@@ -148,6 +148,35 @@ with Api.server() as server:
 
 ```
 
+**LiveClient will auto-trigger a build on code changes, just like the cli does**
+```python
+
+# Live Client will compile against the web-compiler
+from fastapi import Api, LiveClient
+client: LiveClient = Api.live_client(
+    "path/to/sketch_directory",
+)
+# Now user can start editing their sketch and it will auto-compile
+# ... after a while stop it like this.
+client.stop()
+```
+
+**LiveClient with local CompileServer**
+```python
+
+# Live Client will compile against a local server.
+from fastapi import Api, LiveClient
+
+with Api.server() as server:
+    client: LiveClient = Api.live_client(
+        "path/to/sketch_directory",
+        host=server
+    )
+    # Now user can start editing their sketch and it will auto-compile
+    # ... after a while stop it like this.
+    client.stop()
+```
+
 # Features
 
 ## Hot reload by default
@@ -168,11 +197,15 @@ can be much longer, for example if you modify a header file.
 Huge blobs of data like video will absolutely kill the compile performance as these blobs would normally have to be shuffled
 back and forth. Therefore a special directory `data/` is implicitly used to hold this blob data. Any data in this directory
 will be replaced with a stub containing the size and hash of the file during upload. On download these stubs are swapped back
-with their originals.
+with their originals during decompression.
 
 The wasm compiler will recognize all files in the `data/` directory and generate a `files.json` manifest and can be used
 in your wasm sketch using an emulated SD card system mounted at `/data/` on the SD Card. In order to increase load speed, these
-files will be asynchroniously streamed into the running sketch instance during runtime. The only caveat here is that although these files will be available during the setup() phase of the sketch, they will not be fully hydrated, so if you do a seek(end) of these files the results are undefined.
+files will be asynchroniously streamed into the running sketch instance during runtime. Files named with *.json, *.csv, *.txt will be
+immediately injected in the app before setup() is called and can be used immediatly in setup() in their entirety.
+
+All other files will be streamed in. The `Video` element in FastLED is designed to gracefully handle missing data streamed in through
+the file system.
 
 For an example of how to use this see `examples/SdCard` which is fully wasm compatible.
 
@@ -184,11 +217,9 @@ We use `ccache` to cache object files. This seems actually help a lot and is bet
 
 The compilation to wasm will happen under a lock. Removing this lock requires removing the platformio toolchain as the compiler backend which enforces it's own internal lock preventing parallel use.
 
-Simple syntax errors will be caught by the pre-processing step. This happens without a lock to reduce the single lock bottleneck.
-
 ## Sketch Cache
 
-Sketchs are aggresively finger-printed and stored in a cache. White space, comments, and other superficial data will be stripped out during pre-processing and minimization for fingerprinting. This source file decimation is only used for finger
+Sketchs are aggressively finger-printed and stored in a cache. White space, comments, and other superficial data will be stripped out during pre-processing and minimization for fingerprinting. This source file decimation is only used for finger
 printing while the actual source files are sent to compiler to preserve line numbers and file names.
 
 This pre-processing done is done via gcc and special regex's and will happen without a lock. This will allow you to have extremely quick recompiles for whitespace and changes in comments even if the compiler is executing under it's lock.
@@ -225,6 +256,7 @@ A: A big chunk of space is being used by unnecessary javascript `emscripten` is
 
 # Revisions
   
+  * 1.1.39 - Added `LiveClient`, `fastled.Api.live_server()` will spawn it. Allows user to have a live compiling client that re-triggers a compile on file changes.
   * 1.1.38 - Cleanup the `fastled.Api` object and streamline for general use.
   * 1.1.37 - `Test.test_examples()` is now unit tested to work correctly.
   * 1.1.36 - We now have an api. `from fastled import Api` and `from fastled import Test` for testing.