cycls 0.0.2.30__tar.gz → 0.0.2.31__tar.gz

cycls-0.0.2.31/PKG-INFO

@@ -0,0 +1,146 @@
+Metadata-Version: 2.4
+Name: cycls
+Version: 0.0.2.31
+Summary: Cycls SDK
+Author: Mohammed J. AlRujayi
+Author-email: mj@cycls.com
+Requires-Python: >=3.9,<4.0
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Dist: fastapi (>=0.111.0,<0.112.0)
+Requires-Dist: httpx (>=0.27.0,<0.28.0)
+Requires-Dist: jwt (>=1.4.0,<2.0.0)
+Requires-Dist: modal (>=1.1.0,<2.0.0)
+Description-Content-Type: text/markdown
+
+<h3 align="center">
+The Distribution SDK for AI Agents.
+</h3>
+
+<h4 align="center">
+  <a href="https://cycls.com">Website</a> |
+  <a href="https://docs.cycls.com">Docs</a>
+</h4>
+
+<h4 align="center">
+  <a href="https://pypi.python.org/pypi/cycls"><img src="https://img.shields.io/pypi/v/cycls.svg?label=cycls+pypi&color=blueviolet" alt="cycls Python package on PyPi" /></a>
+  <a href="https://blog.cycls.com"><img src="https://img.shields.io/badge/newsletter-blueviolet.svg?logo=substack&label=cycls" alt="Cycls newsletter" /></a>
+  <a href="https://x.com/cyclsai">
+    <img src="https://img.shields.io/twitter/follow/CyclsAI" alt="Cycls Twitter" />
+  </a>
+</h4>
+
+
+# Cycls 🚲
+
+`cycls` is a zero-config framework for building and publishing AI agents. With a single decorator and one command, you can deploy your code as a web application complete with a front-end UI and an OpenAI-compatible API endpoint.
+
+### Design Philosophy
+`cycls` is an anti-framework. We treat the boilerplate, config files, and infrastructure that surround modern applications as a bug to be eliminated. A developer's focus is the most valuable resource, and context-switching is its greatest enemy.
+
+Our zero-config approach makes your Python script the single source of truth for the entire application. When your code is all you need, you stay focused, iterate faster, and ship with confidence.
+
+This philosophy has a powerful side-effect: it makes development genuinely iterative. The self-contained nature of an agent encourages you to 'build in cycles'—starting simple and adding complexity without penalty. This same simplicity also makes `cycls` an ideal target for code generation. Because the entire application can be expressed in one file, LLMs can write, modify, and reason about `cycls` agents far more effectively than with traditional frameworks. It's a seamless interface for both human and machine.
+
+
+## Key Features
+
+* ✨ **Zero-Config Deployment:** No YAML or Dockerfiles. `cycls` infers your dependencies, and APIs directly from your Python code.
+* 🚀 **One-Command Push to Cloud:** Go from local code to a globally scalable, serverless application with a single `agent.push()`.
+* 💻 **Instant Local Testing:** Run `agent.run()` to spin up a local server with hot-reloading for rapid iteration and debugging.
+* 🤖 **OpenAI-Compatible API:** Automatically serves a streaming `/chat/completions` endpoint.
+* 🌐 **Automatic Web UI:** Get a clean, interactive front-end for your agent out of the box, with no front-end code required.
+* 🔐 **Built-in Authentication:** Secure your agent for production with a simple `auth=True` flag that enables JWT-based authentication.
+* 📦 **Declarative Dependencies:** Define all your `pip`, `apt`, or local file dependencies directly in Python.
+
+
+## Installation
+
+```bash
+pip install cycls
+```
+
+## How to Use
+### 1. Local Development: "Hello, World!"
+
+Create a file main.py. This simple example creates an agent that streams back the message "hi".
+
+```py
+import cycls
+
+# Initialize the agent
+agent = cycls.Agent()
+
+# Decorate your function to register it as an agent
+@agent()
+async def hello(context):
+    yield "hi"
+
+agent.run()
+```
+
+Run it from your terminal:
+
+```bash
+python main.py
+```
+This will start a local server. Open your browser to http://127.0.0.1:8000 to interact with your agent.
+
+### 2. Cloud Deployment: An OpenAI-Powered Agent
+This example creates a more advanced agent that calls the OpenAI API. It will be deployed to the cloud with authentication enabled.
+
+```py
+# deploy.py
+import cycls
+
+# Initialize the agent with dependencies and API keys
+agent = cycls.Agent(
+    pip=["openai"],
+    keys=["ak-<token_id>", "as-<token_secret>"]
+)
+
+# A helper function to call the LLM
+async def llm(messages):
+    # Import inside the function: 'openai' is only needed at runtime in the container.
+    import openai
+    client = openai.AsyncOpenAI(api_key="sk-...") # Your OpenAI key
+    model = "gpt-4o"
+    response = await client.chat.completions.create(
+        model=model,
+        messages=messages,
+        temperature=1.0,
+        stream=True
+    )
+    # Yield the content from the streaming response
+    async def event_stream():
+        async for chunk in response:
+            content = chunk.choices[0].delta.content
+            if content:
+                yield content
+    return event_stream()
+
+# Register the function as an agent named "cake" and enable auth
+@agent("cake", auth=True)
+async def cake_agent(context):
+    # The context object contains the message history
+    return await llm(context.messages)
+
+# Deploy the agent to the cloud
+agent.push(prod=True)
+```
+
+Run the deployment command from your terminal:
+
+```bash
+python main.py
+```
+After a few moments, your agent will be live and accessible at a public URL like https://cake.cycls.ai.
+
+### License
+This project is licensed under the MIT License.
+

cycls-0.0.2.31/README.md

@@ -0,0 +1,125 @@
+<h3 align="center">
+The Distribution SDK for AI Agents.
+</h3>
+
+<h4 align="center">
+  <a href="https://cycls.com">Website</a> |
+  <a href="https://docs.cycls.com">Docs</a>
+</h4>
+
+<h4 align="center">
+  <a href="https://pypi.python.org/pypi/cycls"><img src="https://img.shields.io/pypi/v/cycls.svg?label=cycls+pypi&color=blueviolet" alt="cycls Python package on PyPi" /></a>
+  <a href="https://blog.cycls.com"><img src="https://img.shields.io/badge/newsletter-blueviolet.svg?logo=substack&label=cycls" alt="Cycls newsletter" /></a>
+  <a href="https://x.com/cyclsai">
+    <img src="https://img.shields.io/twitter/follow/CyclsAI" alt="Cycls Twitter" />
+  </a>
+</h4>
+
+
+# Cycls 🚲
+
+`cycls` is a zero-config framework for building and publishing AI agents. With a single decorator and one command, you can deploy your code as a web application complete with a front-end UI and an OpenAI-compatible API endpoint.
+
+### Design Philosophy
+`cycls` is an anti-framework. We treat the boilerplate, config files, and infrastructure that surround modern applications as a bug to be eliminated. A developer's focus is the most valuable resource, and context-switching is its greatest enemy.
+
+Our zero-config approach makes your Python script the single source of truth for the entire application. When your code is all you need, you stay focused, iterate faster, and ship with confidence.
+
+This philosophy has a powerful side-effect: it makes development genuinely iterative. The self-contained nature of an agent encourages you to 'build in cycles'—starting simple and adding complexity without penalty. This same simplicity also makes `cycls` an ideal target for code generation. Because the entire application can be expressed in one file, LLMs can write, modify, and reason about `cycls` agents far more effectively than with traditional frameworks. It's a seamless interface for both human and machine.
+
+
+## Key Features
+
+* ✨ **Zero-Config Deployment:** No YAML or Dockerfiles. `cycls` infers your dependencies, and APIs directly from your Python code.
+* 🚀 **One-Command Push to Cloud:** Go from local code to a globally scalable, serverless application with a single `agent.push()`.
+* 💻 **Instant Local Testing:** Run `agent.run()` to spin up a local server with hot-reloading for rapid iteration and debugging.
+* 🤖 **OpenAI-Compatible API:** Automatically serves a streaming `/chat/completions` endpoint.
+* 🌐 **Automatic Web UI:** Get a clean, interactive front-end for your agent out of the box, with no front-end code required.
+* 🔐 **Built-in Authentication:** Secure your agent for production with a simple `auth=True` flag that enables JWT-based authentication.
+* 📦 **Declarative Dependencies:** Define all your `pip`, `apt`, or local file dependencies directly in Python.
+
+
+## Installation
+
+```bash
+pip install cycls
+```
+
+## How to Use
+### 1. Local Development: "Hello, World!"
+
+Create a file main.py. This simple example creates an agent that streams back the message "hi".
+
+```py
+import cycls
+
+# Initialize the agent
+agent = cycls.Agent()
+
+# Decorate your function to register it as an agent
+@agent()
+async def hello(context):
+    yield "hi"
+
+agent.run()
+```
+
+Run it from your terminal:
+
+```bash
+python main.py
+```
+This will start a local server. Open your browser to http://127.0.0.1:8000 to interact with your agent.
+
+### 2. Cloud Deployment: An OpenAI-Powered Agent
+This example creates a more advanced agent that calls the OpenAI API. It will be deployed to the cloud with authentication enabled.
+
+```py
+# deploy.py
+import cycls
+
+# Initialize the agent with dependencies and API keys
+agent = cycls.Agent(
+    pip=["openai"],
+    keys=["ak-<token_id>", "as-<token_secret>"]
+)
+
+# A helper function to call the LLM
+async def llm(messages):
+    # Import inside the function: 'openai' is only needed at runtime in the container.
+    import openai
+    client = openai.AsyncOpenAI(api_key="sk-...") # Your OpenAI key
+    model = "gpt-4o"
+    response = await client.chat.completions.create(
+        model=model,
+        messages=messages,
+        temperature=1.0,
+        stream=True
+    )
+    # Yield the content from the streaming response
+    async def event_stream():
+        async for chunk in response:
+            content = chunk.choices[0].delta.content
+            if content:
+                yield content
+    return event_stream()
+
+# Register the function as an agent named "cake" and enable auth
+@agent("cake", auth=True)
+async def cake_agent(context):
+    # The context object contains the message history
+    return await llm(context.messages)
+
+# Deploy the agent to the cloud
+agent.push(prod=True)
+```
+
+Run the deployment command from your terminal:
+
+```bash
+python main.py
+```
+After a few moments, your agent will be live and accessible at a public URL like https://cake.cycls.ai.
+
+### License
+This project is licensed under the MIT License.

{cycls-0.0.2.30 → cycls-0.0.2.31}/cycls/cycls.py

@@ -100,25 +100,18 @@ def web(func, front_end_path="", prod=False, org=None, api_token=None, header=""
     return app
 
 class Agent:
-    def __init__(self, front_end=theme_path, organization=None, api_token=None, pip=[], apt=[], copy=[], production=False, keys=["",""]):
-        self.prod, self.org, self.api_token = production, organization, api_token
-        self.front_end = front_end
+    def __init__(self, theme=theme_path, org=None, api_token=None, pip=[], apt=[], copy=[], keys=["",""]):
+        self.org, self.api_token = org, api_token
+        self.theme = theme
+        self.keys, self.pip, self.apt, self.copy = keys, pip, apt, copy
+
         self.registered_functions = []
-        self.client = modal.Client.from_credentials(*keys)
-        image = (modal.Image.debian_slim()
-                            .pip_install("fastapi[standard]", "pyjwt", "cryptography", *pip)
-                            .apt_install(*apt)
-                            .add_local_dir(front_end, "/root/public")
-                            .add_local_python_source("cycls"))        
-        for item in copy:
-            image = image.add_local_file(item, f"/root/{item}") if "." in item else image.add_local_dir(item, f'/root/{item}')
-        self.app = modal.App("development", image=image)
 
     def __call__(self, name="", header="", intro="", domain=None, auth=False):
         def decorator(f):
             self.registered_functions.append({
                 "func": f,
-                "config": ["public", self.prod, self.org, self.api_token, header, intro, auth],
+                "config": ["public", False, self.org, self.api_token, header, intro, auth],
                 "name": name,
                 "domain": domain or f"{name}.cycls.ai",
             })
@@ -127,26 +120,39 @@ class Agent:
 
     def run(self, port=8000):
         if not self.registered_functions:
-            return print("Error: No @agent decorated function found.")
+            print("Error: No @agent decorated function found.")
+            return
         
         i = self.registered_functions[0]
         if len(self.registered_functions) > 1:
             print(f"⚠️  Warning: Multiple agents found. Running '{i['name']}'.")
-        print(f"🚀 Starting local server at http://127.0.0.1:{port}")
-        i["config"][0] = self.front_end
-        uvicorn.run(web(i["func"], *i["config"]), host="127.0.0.1", port=port)
+        print(f"🚀 Starting local server at localhost:{port}")
+        i["config"][0], i["config"][6] = self.theme, False
+        uvicorn.run(web(i["func"], *i["config"]), host="0.0.0.0", port=port)
         return
 
-    def push(self): # local / prod?
+    def push(self, prod=False):
+        self.client = modal.Client.from_credentials(*self.keys)
+        image = (modal.Image.debian_slim()
+                            .pip_install("fastapi[standard]", "pyjwt", "cryptography", *self.pip)
+                            .apt_install(*self.apt)
+                            .add_local_dir(self.theme, "/root/public")
+                            .add_local_python_source("cycls"))        
+        for item in self.copy:
+            image = image.add_local_file(item, f"/root/{item}") if "." in item else image.add_local_dir(item, f'/root/{item}')
+        self.app = modal.App("development", image=image)
+    
         if not self.registered_functions:
-            return print("Error: No @agent decorated function found.")
+            print("Error: No @agent decorated function found.")
+            return
 
         for i in self.registered_functions:
+            i["config"][1] = True if prod else False
             self.app.function(serialized=True, name=i["name"])(
                 modal.asgi_app(label=i["name"], custom_domains=[i["domain"]])
                 (lambda: web(i["func"], *i["config"]))
             )
-        if self.prod:
+        if prod:
             for i in self.registered_functions:
                 print(f"✅ Deployed to ⇒ https://{i['domain']}")
             self.app.deploy(client=self.client, name=self.registered_functions[0]["name"])

{cycls-0.0.2.30 → cycls-0.0.2.31}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "cycls"
-version = "0.0.2.30"
+version = "0.0.2.31"
 
 packages = [{ include = "cycls" }]
 include = ["cycls/theme/**/*"]

cycls-0.0.2.30/PKG-INFO

@@ -1,103 +0,0 @@
-Metadata-Version: 2.3
-Name: cycls
-Version: 0.0.2.30
-Summary: Cycls SDK
-Author: Mohammed J. AlRujayi
-Author-email: mj@cycls.com
-Requires-Python: >=3.9,<4.0
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Programming Language :: Python :: 3.13
-Requires-Dist: fastapi (>=0.111.0,<0.112.0)
-Requires-Dist: httpx (>=0.27.0,<0.28.0)
-Requires-Dist: jwt (>=1.4.0,<2.0.0)
-Requires-Dist: modal (>=1.1.0,<2.0.0)
-Description-Content-Type: text/markdown
-
-<p align="center">
-  <img src="https://github.com/user-attachments/assets/96bd304d-8116-4bce-8b8f-b08980875ad7" width="800px" alt="Cycls Banner">
-</p>
-
-<h3 align="center">
-Generate live apps from code in minutes with built-in memory, <br/>rich hypermedia content, and cross-platform support
-</h3>
-
-<h4 align="center">
-  <a href="https://cycls.com">Website</a> |
-  <a href="https://docs.cycls.com">Docs</a> |
-  <a href="https://docs.cycls.com">Blog</a>
-</h4>
-
-<h4 align="center">
-  <a href="https://pypi.python.org/pypi/cycls"><img src="https://img.shields.io/pypi/v/cycls.svg?label=cycls+pypi&color=blueviolet" alt="cycls Python package on PyPi" /></a>
-  <a href="https://blog.cycls.com"><img src="https://img.shields.io/badge/newsletter-blueviolet.svg?logo=substack&label=cycls" alt="Cycls newsletter" /></a>
-  <a href="https://x.com/cycls_">
-    <img src="https://img.shields.io/twitter/follow/cycls_" alt="Cycls Twitter" />
-  </a>
-</h4>
-
-
-## Cycls: The AI App Generator
-Cycls[^1] streamlines AI application development by generating apps from high-level descriptions. It eliminates boilerplate, ensures cross-platform compatibility, and manages memory - all from a single codebase.
-
-With Cycls, you can quickly prototype ideas and then turn them into production apps, while focusing on AI logic and user interactions rather than wrestling with implementation details.
-
-## ✨ Core Features
-- **Fast App Generation**: Create live web apps from code in minutes
-- **Built-in Memory Management**: Integrated state and session management
-- **Rich Hypermedia Content**: Support for various media types (text, images, audio, video, interactive elements)
-- **Framework Agnostic**: Compatible with a wide range of AI frameworks and models
-
-## 🚀 Quickstart
-### Installation
-```
-pip install cycls
-```
-
-### Basic usage
-```py
-from cycls import Cycls
-
-cycls = Cycls()
-
-@cycls("@my-app")
-def app():
-    return "Hello World!"
-
-cycls.push()
-```
-This creates an app named "@my-app" that responds with "Hello World!".
-
-The `@cycls("@my-app")` decorator registers your app, and `cycls.push()` streams it to Cycls platform.
-
-To see a live example, visit https://cycls.com/@spark.
-
-> [!IMPORTANT]
-> Use a unique name for your app (like "@my-app"). This is your app's identifier on Cycls.
-
-> [!NOTE]
-> Your apps run on your infrastructure and are streamed in real-time to Cycls.
-
-## 📖 Documentation
-For more detailes and instructions, visit our documentation at [docs.cycls.com](https://docs.cycls.com/).
-
-## 🗺️ Roadmap
-- **iOS and Android apps**
-- **User management**
-- **JavaScript SDK**
-- **Public API**
-- **Cross-app communication**
-
-## 🙌 Support 
-Join our Discord community for support and discussions. You can reach us on:
-
-- [Join our Discord](https://discord.gg/XbxcTFBf7J)
-- [Join our newsletter](https://blog.cycls.com)
-- [Follow us on Twitter](https://x.com/cycls_)
-- [Email us](mailto:hi@cycls.com)
-
-[^1]: The name "Cycls" is a play on "cycles," referring to the continuous exchange between AI prompts (generators) and their responses (generated).
-

cycls-0.0.2.30/README.md

@@ -1,83 +0,0 @@
-<p align="center">
-  <img src="https://github.com/user-attachments/assets/96bd304d-8116-4bce-8b8f-b08980875ad7" width="800px" alt="Cycls Banner">
-</p>
-
-<h3 align="center">
-Generate live apps from code in minutes with built-in memory, <br/>rich hypermedia content, and cross-platform support
-</h3>
-
-<h4 align="center">
-  <a href="https://cycls.com">Website</a> |
-  <a href="https://docs.cycls.com">Docs</a> |
-  <a href="https://docs.cycls.com">Blog</a>
-</h4>
-
-<h4 align="center">
-  <a href="https://pypi.python.org/pypi/cycls"><img src="https://img.shields.io/pypi/v/cycls.svg?label=cycls+pypi&color=blueviolet" alt="cycls Python package on PyPi" /></a>
-  <a href="https://blog.cycls.com"><img src="https://img.shields.io/badge/newsletter-blueviolet.svg?logo=substack&label=cycls" alt="Cycls newsletter" /></a>
-  <a href="https://x.com/cycls_">
-    <img src="https://img.shields.io/twitter/follow/cycls_" alt="Cycls Twitter" />
-  </a>
-</h4>
-
-
-## Cycls: The AI App Generator
-Cycls[^1] streamlines AI application development by generating apps from high-level descriptions. It eliminates boilerplate, ensures cross-platform compatibility, and manages memory - all from a single codebase.
-
-With Cycls, you can quickly prototype ideas and then turn them into production apps, while focusing on AI logic and user interactions rather than wrestling with implementation details.
-
-## ✨ Core Features
-- **Fast App Generation**: Create live web apps from code in minutes
-- **Built-in Memory Management**: Integrated state and session management
-- **Rich Hypermedia Content**: Support for various media types (text, images, audio, video, interactive elements)
-- **Framework Agnostic**: Compatible with a wide range of AI frameworks and models
-
-## 🚀 Quickstart
-### Installation
-```
-pip install cycls
-```
-
-### Basic usage
-```py
-from cycls import Cycls
-
-cycls = Cycls()
-
-@cycls("@my-app")
-def app():
-    return "Hello World!"
-
-cycls.push()
-```
-This creates an app named "@my-app" that responds with "Hello World!".
-
-The `@cycls("@my-app")` decorator registers your app, and `cycls.push()` streams it to Cycls platform.
-
-To see a live example, visit https://cycls.com/@spark.
-
-> [!IMPORTANT]
-> Use a unique name for your app (like "@my-app"). This is your app's identifier on Cycls.
-
-> [!NOTE]
-> Your apps run on your infrastructure and are streamed in real-time to Cycls.
-
-## 📖 Documentation
-For more detailes and instructions, visit our documentation at [docs.cycls.com](https://docs.cycls.com/).
-
-## 🗺️ Roadmap
-- **iOS and Android apps**
-- **User management**
-- **JavaScript SDK**
-- **Public API**
-- **Cross-app communication**
-
-## 🙌 Support 
-Join our Discord community for support and discussions. You can reach us on:
-
-- [Join our Discord](https://discord.gg/XbxcTFBf7J)
-- [Join our newsletter](https://blog.cycls.com)
-- [Follow us on Twitter](https://x.com/cycls_)
-- [Email us](mailto:hi@cycls.com)
-
-[^1]: The name "Cycls" is a play on "cycles," referring to the continuous exchange between AI prompts (generators) and their responses (generated).