writer 0.6.0__tar.gz

writer-0.6.0/LICENSE.txt

@@ -0,0 +1,190 @@
+                             Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2024 Writer, Inc.
+
+   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.

writer-0.6.0/PKG-INFO

@@ -0,0 +1,111 @@
+Metadata-Version: 2.1
+Name: writer
+Version: 0.6.0
+Summary: An open-source, Python framework for building feature-rich apps that are fully integrated with the Writer platform.
+Home-page: https://www.writer.com
+Keywords: data apps,gui,ui,framework,writer framework
+Author: Writer, Inc.
+Requires-Python: >=3.9.2,<4.0
+Classifier: Development Status :: 4 - Beta
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.9
+Requires-Dist: authlib (>=1.3.0,<2.0.0)
+Requires-Dist: fastapi (>=0.89.1,<1)
+Requires-Dist: gitignore-parser (>=0.1.11,<0.2.0)
+Requires-Dist: jinja2 (>=3.1.4,<4.0.0)
+Requires-Dist: pandas (>=2.2.0,<3)
+Requires-Dist: plotly (>=5.18.0,<6)
+Requires-Dist: pyarrow (>=15.0.0,<16.0.0)
+Requires-Dist: pydantic (>=2.6.0,<3)
+Requires-Dist: python-dateutil (>=2.9.0.post0,<3.0.0)
+Requires-Dist: pytz (>=2024.1,<2025.0)
+Requires-Dist: requests (>=2.31.0,<3.0.0)
+Requires-Dist: uvicorn (>=0.20.0,<1)
+Requires-Dist: watchdog (>=3.0.0,<4)
+Requires-Dist: websockets (>=12,<13)
+Requires-Dist: writer-sdk (>=0.1.2,<1)
+Project-URL: Documentation, https://dev.writer.com/framework
+Project-URL: Repository, https://www.github.com/streamsync-cloud/streamsync
+Description-Content-Type: text/markdown
+
+## What is Writer Framework?
+
+Writer Framework is an open-source framework for creating AI applications. Build user interfaces using a visual editor; write the backend code in Python.
+
+Writer Framework is fast and flexible with a clean, easily-testable syntax. It provides separation of concerns between UI and business logic, enabling more complex applications.
+
+## Highlights
+
+### Reactive and state-driven
+
+Writer Framework is **fully state-driven** and provides **separation of concerns** between user interface and business logic.
+
+```py
+import writer as wf
+
+def handle_increment(state):
+    state["counter"] += 1
+
+wf.init_state({
+    "counter": 0
+})
+```
+
+The user interface is a template, which is defined visually. The template contains reactive references to state, e.g. `@{counter}`, and references to event handlers, e.g. when _Button_ is clicked, trigger `handle_increment`.
+
+### Flexible
+
+- Elements are highly customizable with no CSS required, allowing for shadows, button icons, background colors, etc.
+- HTML elements with custom CSS can be included using the _HTML Element_ component. They can serve as containers for built-in components.
+
+### Fast
+
+- Event handling adds minimal overhead to your Python code (~1-2ms\*).
+- Streaming (WebSockets) is used to synchronize frontend and backend states.
+- The script only runs once.
+- Non-blocking by default. Events are handled asynchronously in a thread pool running in a dedicated process.
+
+\*End-to-end figure, including DOM mutation. Tested locally on a Macbook Air M2. [Measurement methodology](https://medium.com/@ramiromedina/measuring-time-elapsed-between-an-event-and-its-associated-dom-mutation-80431ad576e1).
+
+### Developer-friendly
+
+- It's all contained in a standard Python package, just one `pip install` away.
+- User interfaces are saved as JSON, so they can be version controlled together with the rest of the application.
+- Use your local code editor and get instant refreshes when you save your code. Alternatively, use the provided web-based editor.
+- You edit the UI while your app is running. No hitting "Preview" and seeing something completely different to what you expected.
+
+## Installation and Quickstart
+
+Getting started with Writer Framework is easy. It works on Linux, Mac and Windows.
+
+```sh
+pip install writer
+writer hello
+```
+
+- The first command will install Writer Framework using `pip`.
+- The second command will create a demo application in the subfolder "hello" and start Writer Framework Builder, the framework's visual editor, which will be accessible via a local URL.
+
+The following commands can be used to create, launch Writer Framework Builder and run an application.
+
+```sh
+writer create my_app
+writer edit my_app
+writer run my_app
+```
+
+## Documentation
+
+Full documentation, including how to use Writer's AI module and deployment options, is available at [Writer](https://dev.writer.com/framework?utm_source=github&utm_medium=readme&utm_campaign=framework).
+
+## About Writer
+
+Writer is the full-stack generative AI platform for enterprises. Quickly and easily build and deploy generative AI apps with a suite of developer tools fully integrated with our platform of LLMs, graph-based RAG tools, AI guardrails, and more. Learn more at [writer.com](https://www.writer.com?utm_source=github&utm_medium=readme&utm_campaign=framework).
+
+## License
+
+This project is licensed under the Apache 2.0 License.
+

writer-0.6.0/README.md

@@ -0,0 +1,77 @@
+## What is Writer Framework?
+
+Writer Framework is an open-source framework for creating AI applications. Build user interfaces using a visual editor; write the backend code in Python.
+
+Writer Framework is fast and flexible with a clean, easily-testable syntax. It provides separation of concerns between UI and business logic, enabling more complex applications.
+
+## Highlights
+
+### Reactive and state-driven
+
+Writer Framework is **fully state-driven** and provides **separation of concerns** between user interface and business logic.
+
+```py
+import writer as wf
+
+def handle_increment(state):
+    state["counter"] += 1
+
+wf.init_state({
+    "counter": 0
+})
+```
+
+The user interface is a template, which is defined visually. The template contains reactive references to state, e.g. `@{counter}`, and references to event handlers, e.g. when _Button_ is clicked, trigger `handle_increment`.
+
+### Flexible
+
+- Elements are highly customizable with no CSS required, allowing for shadows, button icons, background colors, etc.
+- HTML elements with custom CSS can be included using the _HTML Element_ component. They can serve as containers for built-in components.
+
+### Fast
+
+- Event handling adds minimal overhead to your Python code (~1-2ms\*).
+- Streaming (WebSockets) is used to synchronize frontend and backend states.
+- The script only runs once.
+- Non-blocking by default. Events are handled asynchronously in a thread pool running in a dedicated process.
+
+\*End-to-end figure, including DOM mutation. Tested locally on a Macbook Air M2. [Measurement methodology](https://medium.com/@ramiromedina/measuring-time-elapsed-between-an-event-and-its-associated-dom-mutation-80431ad576e1).
+
+### Developer-friendly
+
+- It's all contained in a standard Python package, just one `pip install` away.
+- User interfaces are saved as JSON, so they can be version controlled together with the rest of the application.
+- Use your local code editor and get instant refreshes when you save your code. Alternatively, use the provided web-based editor.
+- You edit the UI while your app is running. No hitting "Preview" and seeing something completely different to what you expected.
+
+## Installation and Quickstart
+
+Getting started with Writer Framework is easy. It works on Linux, Mac and Windows.
+
+```sh
+pip install writer
+writer hello
+```
+
+- The first command will install Writer Framework using `pip`.
+- The second command will create a demo application in the subfolder "hello" and start Writer Framework Builder, the framework's visual editor, which will be accessible via a local URL.
+
+The following commands can be used to create, launch Writer Framework Builder and run an application.
+
+```sh
+writer create my_app
+writer edit my_app
+writer run my_app
+```
+
+## Documentation
+
+Full documentation, including how to use Writer's AI module and deployment options, is available at [Writer](https://dev.writer.com/framework?utm_source=github&utm_medium=readme&utm_campaign=framework).
+
+## About Writer
+
+Writer is the full-stack generative AI platform for enterprises. Quickly and easily build and deploy generative AI apps with a suite of developer tools fully integrated with our platform of LLMs, graph-based RAG tools, AI guardrails, and more. Learn more at [writer.com](https://www.writer.com?utm_source=github&utm_medium=readme&utm_campaign=framework).
+
+## License
+
+This project is licensed under the Apache 2.0 License.

writer-0.6.0/pyproject.toml

@@ -0,0 +1,102 @@
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.poetry]
+name = "writer"
+version = "0.6.0"
+description = "An open-source, Python framework for building feature-rich apps that are fully integrated with the Writer platform."
+authors = ["Writer, Inc."]
+readme = "README.md"
+homepage = "https://www.writer.com"
+repository = "https://www.github.com/streamsync-cloud/streamsync"
+documentation = "https://dev.writer.com/framework"
+keywords = ["data apps", "gui", "ui", "framework", "writer framework"]
+classifiers = [
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Development Status :: 4 - Beta"
+]
+packages = [
+    { include = "writer", from = "src" }
+]
+include = [
+    "src/writer/*.py",
+    "src/writer/static/**/*",
+    "src/writer/templates/**/*",
+    "src/writer/app_templates/**/*"
+]
+
+[tool.poetry.dependencies]
+authlib = "^1.3.0"
+fastapi = ">= 0.89.1, < 1"
+gitignore-parser = "^0.1.11"
+jinja2 = "^3.1.4"
+pandas = ">= 2.2.0, < 3"
+plotly = ">= 5.18.0, < 6"
+pyarrow = ">= 15.0.0, < 16.0.0"
+pydantic = ">= 2.6.0, < 3"
+python = ">=3.9.2, <4.0"
+python-dateutil = "^2.9.0.post0"
+pytz = "^2024.1"
+requests = "^2.31.0"
+uvicorn = ">= 0.20.0, < 1"
+watchdog = ">= 3.0.0, < 4"
+websockets = ">= 12, < 13"
+writer-sdk = ">= 0.1.2, < 1"
+
+
+[tool.poetry.group.build]
+optional = true
+
+[tool.poetry.group.build.dependencies]
+alfred-cli = "^2.2.7"
+altair = ">= 5.2.0, < 6"
+httpx = ">=0.26.0, < 1"
+mypy = ">= 1.8.0, < 2"
+pandas = ">= 2.2.0, < 3"
+pandas-stubs = ">= 2.0.0, <3"
+plotly = ">= 5.18.0, < 6"
+polars = "^0.20.15"
+pyarrow = ">= 15.0.0, < 16.0.0"
+pytest = ">= 7.0.0, < 8"
+pytest-asyncio = ">= 0.23.4, < 1"
+ruff = "^0.3.4"
+types-requests = "^2.31.0.20240406"
+
+
+[tool.poetry.group.dev.dependencies]
+types-python-dateutil = "^2.9.0.20240316"
+
+[tool.poetry.scripts]
+writer = 'writer.command_line:main'
+
+
+[tool.ruff]
+exclude = [
+    "src/ui",
+		"src/writer/ui.py",
+    "docs",
+    "tests/e2e",
+    ".git",
+]
+
+line-length = 100
+indent-width = 4
+target-version = "py39"
+
+[tool.ruff.lint]
+select = ["I","E", "F", "C"]
+ignore = ["E501", "C901", "E712", "F401"]
+fixable = ["ALL"]
+unfixable = []
+
+[tool.ruff.format]
+quote-style = "double"
+indent-style = "space"
+skip-magic-trailing-comma = false
+line-ending = "auto"
+
+

writer-0.6.0/src/writer/__init__.py

@@ -0,0 +1,130 @@
+import importlib.metadata
+from types import ModuleType
+from typing import Any, Dict, List, Optional, Type, TypeVar, Union, cast
+
+from writer.core import (
+    BytesWrapper,
+    Config,
+    FileWrapper,
+    Readable,
+    State,
+    WriterState,
+    base_component_tree,
+    initial_state,
+    new_initial_state,
+    session_manager,
+    session_verifier,
+)
+from writer.ui import WriterUIManager
+
+VERSION = importlib.metadata.version("writer")
+
+base_component_tree
+session_manager
+Config
+session_verifier
+
+
+def pack_file(file: Union[Readable, str], mime_type: Optional[str] = None):
+    """
+    Returns a FileWrapper for the file provided, which is automatically
+    serialised to a data URL.
+    """
+
+    return FileWrapper(file, mime_type)
+
+
+def pack_bytes(raw_data, mime_type: Optional[str] = None):
+    """
+    Returns a BytesWrapper for the bytes raw data provided, which is automatically
+    serialised to a data URL.
+    """
+
+    return BytesWrapper(raw_data, mime_type)
+
+
+S = TypeVar('S', bound=WriterState)
+
+
+def init_ui() -> WriterUIManager:
+    """Initializes and returns an instance of WriterUIManager.
+    This manager provides methods to dynamically create and manage UI
+    components in a Writer Framework application.
+
+    The WriterUIManager allows for the creation of application-wide,
+    code-managed components during startup, ensuring that the set of components
+    is initially accessible by all sessions.
+
+    :return: An instance that serves as a bridge for programmatically
+    interacting with the frontend, facilitating dynamic UI component management.
+    :rtype: WriterUIManager
+
+    **Example**::
+
+    >>> import writer as wf
+    >>>
+    >>> with wf.init_ui() as ui:
+    >>>     with ui.Page({"key": "hello"}):
+    >>>         ui.Text({"text": "Hello pigeons"})
+    """
+    return WriterUIManager()
+
+
+def init_state(raw_state: Dict[str, Any], schema: Optional[Type[S]] = None) -> Union[S, WriterState]:
+    """
+    Sets the initial state, which will be used as the starting point for
+    every session.
+
+    initial_state.user_state.state = {}
+    initial_state.user_state.ingest(state_dict)
+    return initial_state
+
+
+
+    >>> import writer as wf
+
+    >>> initial_state = wf.init_state({
+    >>>   "counter": 0,
+    >>> }, schema=AppSchema)
+    """
+    concrete_schema = cast(Type[S], WriterState if schema is None else schema)
+    if not issubclass(concrete_schema, WriterState):
+        raise ValueError("Root schema must inherit from WriterState")
+
+    _initial_state: S = new_initial_state(concrete_schema, raw_state)
+    return _initial_state
+
+
+def init_handlers(handler_modules: Union[List[ModuleType], ModuleType]):
+    """
+    Registers one or more handler modules to enable its containing functions
+    to be used as event handlers by the application's frontend.
+
+    :param handler_modules: A module or list of modules for registration.
+    :type handler_modules: module or list of modules
+
+    **Examples**
+
+    Register a single handler module:
+
+    >>> import writer as wf
+    >>> import my_handler_module
+    >>> wf.init_handlers(my_handler_module)
+
+    Register multiple handler modules:
+
+    >>> import writer as wf
+    >>> import module_one, module_two
+    >>> wf.init_handlers([module_one, module_two])
+
+    :raises ValueError: If an object that is not a module is attempted to be registered.
+    """
+    from writer.core import get_app_process
+    current_app_process = get_app_process()
+    handler_registry = current_app_process.handler_registry
+    # Ensure handler_modules is a list
+    if not isinstance(handler_modules, list):
+        handler_modules = [handler_modules]
+
+    for module in handler_modules:
+        handler_registry.register_module(module)