flamepy 0.3.0__tar.gz

flamepy-0.3.0/LICENSE

@@ -0,0 +1,201 @@
+                                 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
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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.

flamepy-0.3.0/PKG-INFO

@@ -0,0 +1,177 @@
+Metadata-Version: 2.4
+Name: flamepy
+Version: 0.3.0
+Summary: Python SDK for Flame distributed engine
+Author-email: XFLOPS Authors <support@xflops.io>
+Project-URL: Homepage, https://xflops.io
+Project-URL: Repository, https://github.com/xflops/flame
+Project-URL: Issues, https://github.com/xflops/flame/issues
+Keywords: distributed computing,flame,sdk
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: grpcio>=1.50.0
+Requires-Dist: grpcio-tools>=1.50.0
+Requires-Dist: protobuf>=4.21.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0.0; extra == "dev"
+Requires-Dist: pytest-asyncio>=0.21.0; extra == "dev"
+Requires-Dist: black>=22.0.0; extra == "dev"
+Requires-Dist: isort>=5.0.0; extra == "dev"
+Requires-Dist: mypy>=1.0.0; extra == "dev"
+Dynamic: license-file
+
+# Flame Python SDK
+
+Python SDK for the Flame distributed computing framework.
+
+## Installation
+
+```bash
+pip install flamepy
+```
+
+## Quick Start
+
+```python
+import asyncio
+from flamepy import SessionAttributes, connect
+
+async def main():
+    # Connect to Flame service
+    conn = await connect("http://localhost:8080")
+    # Create a session
+    session = await conn.create_session(SessionAttributes(
+        application="flmlog",
+        slots=2,
+        common_data=b"shared data"
+    ))
+    
+    # Create and run a task
+    task = await session.create_task(b"task input data")
+    
+    # Watch task progress
+    async for update in session.watch_task(task.id):
+        print(f"Task {task.id}: {update.state}")
+        if update.is_completed():
+            break
+    
+    # Close session
+    await session.close()
+    await conn.close()
+
+if __name__ == "__main__":
+    asyncio.run(main())
+```
+
+## API Reference
+
+### Connection
+
+The main entry point for connecting to Flame services.
+
+```python
+from flamepy import connect
+
+# Connect to a Flame service
+conn = await connect("http://localhost:8080")
+```
+
+### Session
+
+Represents a computing session with distributed resources.
+
+```python
+# Create a session
+session = await conn.create_session(SessionAttributes(
+    application="my-app",
+    slots=2
+))
+
+# List sessions
+sessions = await conn.list_sessions()
+
+# Close a session
+await session.close()
+```
+
+### Task
+
+Represents individual computing tasks within a session.
+
+```python
+# Create a task
+task = await session.create_task(b"input data")
+
+# Get task status
+task = await session.get_task(task.id)
+
+# Watch task progress
+async for update in session.watch_task(task.id):
+    print(f"Task state: {update.state}")
+    if update.is_completed():
+        break
+```
+
+### Application
+
+Manage distributed applications.
+
+```python
+# Register an application
+await conn.register_application("my-app", {
+    "shim": Shim.SHELL,
+    "command": "python",
+    "arguments": ["script.py"]
+})
+
+# List applications
+apps = await conn.list_applications()
+```
+
+## Error Handling
+
+The SDK provides custom exception types for different error scenarios:
+
+```python
+from flamepy import FlameError, FlameErrorCode
+
+try:
+    session = await conn.create_session(attrs)
+except FlameError as e:
+    if e.code == FlameErrorCode.INVALID_CONFIG:
+        print("Configuration error:", e.message)
+    elif e.code == FlameErrorCode.INVALID_STATE:
+        print("State error:", e.message)
+```
+
+## Development
+
+To set up the development environment:
+
+```bash
+# Clone the repository
+git clone https://github.com/flame-sh/flame.git
+cd flame/sdk/python
+
+# Install in development mode
+pip install -e .[dev]
+
+# Run tests
+pytest
+
+# Format code
+black flamepy/
+isort flamepy/
+
+# Type checking
+mypy flamepy/
+``` 

flamepy-0.3.0/README.md

@@ -0,0 +1,146 @@
+# Flame Python SDK
+
+Python SDK for the Flame distributed computing framework.
+
+## Installation
+
+```bash
+pip install flamepy
+```
+
+## Quick Start
+
+```python
+import asyncio
+from flamepy import SessionAttributes, connect
+
+async def main():
+    # Connect to Flame service
+    conn = await connect("http://localhost:8080")
+    # Create a session
+    session = await conn.create_session(SessionAttributes(
+        application="flmlog",
+        slots=2,
+        common_data=b"shared data"
+    ))
+    
+    # Create and run a task
+    task = await session.create_task(b"task input data")
+    
+    # Watch task progress
+    async for update in session.watch_task(task.id):
+        print(f"Task {task.id}: {update.state}")
+        if update.is_completed():
+            break
+    
+    # Close session
+    await session.close()
+    await conn.close()
+
+if __name__ == "__main__":
+    asyncio.run(main())
+```
+
+## API Reference
+
+### Connection
+
+The main entry point for connecting to Flame services.
+
+```python
+from flamepy import connect
+
+# Connect to a Flame service
+conn = await connect("http://localhost:8080")
+```
+
+### Session
+
+Represents a computing session with distributed resources.
+
+```python
+# Create a session
+session = await conn.create_session(SessionAttributes(
+    application="my-app",
+    slots=2
+))
+
+# List sessions
+sessions = await conn.list_sessions()
+
+# Close a session
+await session.close()
+```
+
+### Task
+
+Represents individual computing tasks within a session.
+
+```python
+# Create a task
+task = await session.create_task(b"input data")
+
+# Get task status
+task = await session.get_task(task.id)
+
+# Watch task progress
+async for update in session.watch_task(task.id):
+    print(f"Task state: {update.state}")
+    if update.is_completed():
+        break
+```
+
+### Application
+
+Manage distributed applications.
+
+```python
+# Register an application
+await conn.register_application("my-app", {
+    "shim": Shim.SHELL,
+    "command": "python",
+    "arguments": ["script.py"]
+})
+
+# List applications
+apps = await conn.list_applications()
+```
+
+## Error Handling
+
+The SDK provides custom exception types for different error scenarios:
+
+```python
+from flamepy import FlameError, FlameErrorCode
+
+try:
+    session = await conn.create_session(attrs)
+except FlameError as e:
+    if e.code == FlameErrorCode.INVALID_CONFIG:
+        print("Configuration error:", e.message)
+    elif e.code == FlameErrorCode.INVALID_STATE:
+        print("State error:", e.message)
+```
+
+## Development
+
+To set up the development environment:
+
+```bash
+# Clone the repository
+git clone https://github.com/flame-sh/flame.git
+cd flame/sdk/python
+
+# Install in development mode
+pip install -e .[dev]
+
+# Run tests
+pytest
+
+# Format code
+black flamepy/
+isort flamepy/
+
+# Type checking
+mypy flamepy/
+``` 

flamepy-0.3.0/pyproject.toml

@@ -0,0 +1,97 @@
+[build-system]
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "flamepy"
+version = "0.3.0"
+description = "Python SDK for Flame distributed engine"
+readme = "README.md"
+requires-python = ">=3.8"
+license-files = ["LICENSE"]
+authors = [
+  {name = "XFLOPS Authors", email = "support@xflops.io"}
+]
+keywords = ["distributed computing", "flame", "sdk"]
+classifiers = [
+  "Development Status :: 3 - Alpha",
+  "Intended Audience :: Developers",
+  "Operating System :: OS Independent",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.8",
+  "Programming Language :: Python :: 3.9",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+]
+dependencies = [
+  "grpcio>=1.50.0",
+  "grpcio-tools>=1.50.0",
+  "protobuf>=4.21.0",
+]
+
+[project.optional-dependencies]
+dev = [
+  "pytest>=7.0.0",
+  "pytest-asyncio>=0.21.0",
+  "black>=22.0.0",
+  "isort>=5.0.0",
+  "mypy>=1.0.0",
+]
+
+[tool.setuptools.packages.find]
+where = [
+    "src"
+]
+
+[project.urls]
+Homepage = "https://xflops.io"
+Repository = "https://github.com/xflops/flame"
+Issues = "https://github.com/xflops/flame/issues"
+
+[tool.black]
+line-length = 88
+target-version = ['py38']
+include = '\.pyi?$'
+extend-exclude = '''
+/(
+  # directories
+  \.eggs
+  | \.git
+  | \.hg
+  | \.mypy_cache
+  | \.tox
+  | \.venv
+  | build
+  | dist
+)/
+'''
+
+[tool.isort]
+profile = "black"
+multi_line_output = 3
+line_length = 88
+known_first_party = ["flame"]
+
+[tool.mypy]
+python_version = "3.8"
+warn_return_any = true
+warn_unused_configs = true
+disallow_untyped_defs = true
+disallow_incomplete_defs = true
+check_untyped_defs = true
+disallow_untyped_decorators = true
+no_implicit_optional = true
+warn_redundant_casts = true
+warn_unused_ignores = true
+warn_no_return = true
+warn_unreachable = true
+strict_equality = true
+
+[[tool.mypy.overrides]]
+module = [
+    "grpc.*",
+    "grpc.aio.*",
+    "grpc_tools.*",
+]
+ignore_missing_imports = true 
+

flamepy-0.3.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

flamepy-0.3.0/src/flamepy/__init__.py

@@ -0,0 +1,82 @@
+
+from .types import (
+    # Type aliases
+    TaskID,
+    SessionID,
+    ApplicationID,
+    Message,
+    TaskInput,
+    TaskOutput,
+    CommonData,
+    
+    # Enums
+    SessionState,
+    TaskState,
+    Shim,
+
+    FlameErrorCode,
+    
+    # Classes
+    FlameError,
+    SessionAttributes,
+    ApplicationAttributes,
+    Task,
+    Application,
+    FlameContext,
+    TaskInformer,
+)
+
+from .client import Connection, Session, TaskWatcher, connect, create_session
+from .service import (
+    FlameService,
+    ApplicationContext, SessionContext, TaskContext, TaskOutput,
+    run
+)
+__version__ = "0.1.0"
+
+__all__ = [
+    # Type aliases
+    "TaskID",
+    "SessionID", 
+    "ApplicationID",
+    "Message",
+    "TaskInput",
+    "TaskOutput",
+    "CommonData",
+    
+    # Enums
+    "SessionState",
+    "TaskState", 
+    "ApplicationState",
+    "Shim",
+    "FlameErrorCode",
+
+    # Service classes
+    "FlameService",
+    "ApplicationContext",
+    "SessionContext",
+    "TaskContext",
+    "TaskOutput",
+    "run",
+
+    # Classes
+    "FlameError",
+    "SessionAttributes",
+    "ApplicationAttributes", 
+    "Session",
+    "Task",
+    "Application",
+    "FlameContext",
+    "TaskInformer",
+    
+    # Client classes
+    "Connection",
+    "connect",
+    "create_session",
+    "TaskWatcher",
+    "Session", 
+    "Task",
+    "TaskInput",
+    "TaskOutput",
+    "CommonData",
+]