cycls 0.0.2.47__tar.gz → 0.0.2.49__tar.gz

{cycls-0.0.2.47 → cycls-0.0.2.49}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cycls
-Version: 0.0.2.47
+Version: 0.0.2.49
 Summary: Cycls SDK
 Author: Mohammed J. AlRujayi
 Author-email: mj@cycls.com
@@ -40,15 +40,7 @@ The Distribution SDK for AI Agents.
 
 # 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.
-
+`cycls` is an open-source SDK 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.
 
 ## Key Features
 
@@ -67,6 +59,8 @@ This philosophy has a powerful side-effect: it makes development genuinely itera
 pip install cycls
 ```
 
+**Note:** You must have [Docker](https://www.docker.com/get-started) installed and running on your machine.
+
 ## How to Use
 ### 1. Local Development: "Hello, World!"
 
@@ -81,9 +75,9 @@ agent = cycls.Agent()
 # Decorate your function to register it as an agent
 @agent()
 async def hello(context):
-    yield "hi"
+    yield "Hello, World!"
 
-agent.local()
+agent.deploy(prod=False)
 ```
 
 Run it from your terminal:
@@ -103,12 +97,12 @@ import cycls
 # Initialize the agent with dependencies and API keys
 agent = cycls.Agent(
     pip=["openai"],
-    keys=["ak-<token_id>", "as-<token_secret>"]
+    key=["YOUR_CYCLS_KEY"] # Get yours from cycls.com
 )
 
 # 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 inside the function: 'openai' is needed at runtime in the container.
     import openai
     client = openai.AsyncOpenAI(api_key="sk-...") # Your OpenAI key
     model = "gpt-4o"

{cycls-0.0.2.47 → cycls-0.0.2.49}/README.md

@@ -18,15 +18,7 @@ The Distribution SDK for AI Agents.
 
 # 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.
-
+`cycls` is an open-source SDK 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.
 
 ## Key Features
 
@@ -45,6 +37,8 @@ This philosophy has a powerful side-effect: it makes development genuinely itera
 pip install cycls
 ```
 
+**Note:** You must have [Docker](https://www.docker.com/get-started) installed and running on your machine.
+
 ## How to Use
 ### 1. Local Development: "Hello, World!"
 
@@ -59,9 +53,9 @@ agent = cycls.Agent()
 # Decorate your function to register it as an agent
 @agent()
 async def hello(context):
-    yield "hi"
+    yield "Hello, World!"
 
-agent.local()
+agent.deploy(prod=False)
 ```
 
 Run it from your terminal:
@@ -81,12 +75,12 @@ import cycls
 # Initialize the agent with dependencies and API keys
 agent = cycls.Agent(
     pip=["openai"],
-    keys=["ak-<token_id>", "as-<token_secret>"]
+    key=["YOUR_CYCLS_KEY"] # Get yours from cycls.com
 )
 
 # 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 inside the function: 'openai' is needed at runtime in the container.
     import openai
     client = openai.AsyncOpenAI(api_key="sk-...") # Your OpenAI key
     model = "gpt-4o"

{cycls-0.0.2.47 → cycls-0.0.2.49}/cycls/sdk.py

@@ -4,25 +4,24 @@ from modal.runner import run_app
 from .web import web
 import importlib.resources
 
-theme_path = importlib.resources.files('cycls').joinpath('theme')
-cycls_path = importlib.resources.files('cycls')
+CYCLS_PATH = importlib.resources.files('cycls')
 
-def function(python_version=None, pip=None, apt=None, run_commands=None, copy=None, name=None, base_url=None, api_key=None):
+def function(python_version=None, pip=None, apt=None, run_commands=None, copy=None, name=None, base_url=None, key=None):
     # """
     # A decorator factory that transforms a Python function into a containerized,
     # remotely executable object.
     def decorator(func):
         Name = name or func.__name__
         copy_dict = {i:i for i in copy or []}
-        return Runtime(func, Name.replace('_', '-'), python_version, pip, apt, run_commands, copy_dict, base_url, api_key)
+        return Runtime(func, Name.replace('_', '-'), python_version, pip, apt, run_commands, copy_dict, base_url, key)
     return decorator
 
 class Agent:
-    def __init__(self, theme=theme_path, org=None, api_token=None, pip=[], apt=[], copy=[], copy_public=[], keys=["",""], api_key=None):
+    def __init__(self, theme=CYCLS_PATH.joinpath('theme'), org=None, api_token=None, pip=[], apt=[], copy=[], copy_public=[], modal_keys=["",""], key=None, base_url=None):
         self.org, self.api_token = org, api_token
         self.theme = theme
-        self.keys, self.pip, self.apt, self.copy, self.copy_public = keys, pip, apt, copy, copy_public
-        self.api_key = api_key
+        self.key, self.modal_keys, self.pip, self.apt, self.copy, self.copy_public = key, modal_keys, pip, apt, copy, copy_public
+        self.base_url = base_url
 
         self.registered_functions = []
 
@@ -30,7 +29,7 @@ class Agent:
         def decorator(f):
             self.registered_functions.append({
                 "func": f,
-                "config": ["public", False, self.org, self.api_token, header, intro, title, auth],
+                "config": ["theme", False, self.org, self.api_token, header, intro, title, auth],
                 # "name": name,
                 "name": name or (f.__name__).replace('_', '-'),
                 "domain": domain or f"{name}.cycls.ai",
@@ -55,7 +54,7 @@ class Agent:
         if not self.registered_functions:
             print("Error: No @agent decorated function found.")
             return
-        if (self.api_key is None) and prod:
+        if (self.key is None) and prod:
             print("🛑  Error: Please add your Cycls API key")
             return
 
@@ -65,38 +64,44 @@ class Agent:
 
         i["config"][1] = False
 
-        copy={str(self.theme):"public", str(cycls_path)+"/web.py":"web.py"}
+        copy={str(self.theme):"theme", str(CYCLS_PATH)+"/web.py":"web.py"}
         copy.update({i:i for i in self.copy})
-        copy.update({i:f"a/{i}" for i in self.copy_public})
+        copy.update({i:f"public/{i}" for i in self.copy_public})
 
-        def runner(port):
+        def server(port):
             import uvicorn, logging
             # This one-liner hides the confusing "0.0.0.0" message
             logging.getLogger("uvicorn.error").addFilter(type("F",(),{"filter": lambda s,r: "0.0.0.0" not in r.getMessage()})())
-            print(f"\n🚀 Local Link: http://localhost:{port}\n")
+            print(f"\n🔨 Visit {i["name"]} => http://localhost:{port}\n")
             uvicorn.run(__import__("web").web(i["func"], *i["config"]), host="0.0.0.0", port=port)
 
         new = Runtime(
             # func=lambda port: __import__("uvicorn").run(__import__("web").web(i["func"], *i["config"]), host="0.0.0.0", port=port),
-            func=runner,
+            func=server,
             name=i["name"],
             apt_packages=self.apt,
             pip_packages=["fastapi[standard]", "pyjwt", "cryptography", "uvicorn", *self.pip],
             copy=copy,
-            api_key=self.api_key
+            base_url=self.base_url,
+            api_key=self.key
         )
         new.deploy(port=port) if prod else new.run(port=port) 
         return
         
     def modal(self, prod=False):
-        self.client = modal.Client.from_credentials(*self.keys)
+        self.client = modal.Client.from_credentials(*self.modal_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_file(str(cycls_path)+"/web.py", "/root/web.py"))
+                            .add_local_dir(self.theme, "/root/theme")
+                            .add_local_file(str(CYCLS_PATH)+"/web.py", "/root/web.py"))
+       
         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}')
+        
+        for item in self.copy_public:
+            image = image.add_local_file(item, f"/root/public/{item}") if "." in item else image.add_local_dir(item, f'/root/public/{item}')
+
         self.app = modal.App("development", image=image)
     
         if not self.registered_functions:

{cycls-0.0.2.47 → cycls-0.0.2.49}/cycls/web.py

@@ -119,8 +119,8 @@ def web(func, public_path="", prod=False, org=None, api_token=None, header="", i
             pk_test="pk_test_c2VsZWN0LXNsb3RoLTU4LmNsZXJrLmFjY291bnRzLmRldiQ"
         )
 
-    if Path("a").is_dir():
-        app.mount("/a", StaticFiles(directory="a", html=True))
+    if Path("public").is_dir():
+        app.mount("/public", StaticFiles(directory="public", html=True))
     app.mount("/", StaticFiles(directory=public_path, html=True))
 
     return app

{cycls-0.0.2.47 → cycls-0.0.2.49}/pyproject.toml

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