tinybird 0.0.1.dev112__py3-none-any.whl → 0.0.1.dev113__py3-none-any.whl

tinybird/prompts.py

@@ -954,3 +954,35 @@ FORWARD_QUERY >
     </forward_query_example>
 </deployment_instruction>
 """
+
+
+def readme_prompt(readme: str, host: str, token: str, resources_xml: str) -> str:
+    return f"""
+You are an expert in SQL and Tinybird. Follow these instructions to generate a new README.md file for a tinybird project:
+Current README.md file:
+<current_resources_xml>
+{resources_xml}
+</current_resources_xml>
+<readme>{readme}</readme>
+<readme_instructions>
+- If it is not present in the current readme, generate a new ## Tinybird section with the following content:
+    - ### Overview section:
+        - Explaining the purpose of the project.
+    - ### Data sources section: 
+        - Explaining the purpose of each datasource.
+        - Add a snippet of how to ingest data into each datasource like the following (where the payload example matches the datasource schema respecting non-nullable types):
+        curl -X POST "{host}/v0/events?name=events" \
+    -H "Authorization: Bearer {token}" \
+    -d '{{"date":"2025-01-31","id":"123","user_id":"abc"}}'
+    - ### Endpoints section:
+        - Explaining the purpose of each endpoint.
+        - Add a snippet of how to use each endpoint like the following:
+        curl -X GET "{host}/v0/pipes/pipe_name.json?token={token}"
+        - DateTime parameters must be formatted as YYYY-MM-DD HH:MM:SS, or else will fail.
+- Do not include any other extra info related to Tinybird just maintain the existing one in the <readme> tag.
+- Make sure the API host is correct, {host}.
+- It is mandatory to return a <resource> tag with type "readme" in the response.
+- The response must follow the following format:
+<readme>[readme content here]</readme>
+</readme_instructions>
+"""

tinybird/tb/__cli__.py

@@ -4,5 +4,5 @@ __description__ = 'Tinybird Command Line Tool'
 __url__ = 'https://www.tinybird.co/docs/cli/introduction.html'
 __author__ = 'Tinybird'
 __author_email__ = 'support@tinybird.co'
-__version__ = '0.0.1.dev112'
-__revision__ = 'eb9e376'
+__version__ = '0.0.1.dev113'
+__revision__ = '49946d6'

tinybird/tb/modules/cicd.py

@@ -120,7 +120,9 @@ tinybird_ci_workflow:
   services:
     - name: tinybirdco/tinybird-local:beta
       alias: tinybird-local
+"""
 
+GITLAB_CD_YML = """
 tinybird_cd_workflow:
   image: ubuntu:latest
   stage: deploy
@@ -217,6 +219,11 @@ class GitLabCICDGenerator(CICDGeneratorBase):
             file_name="tinybird-ci.yml",
             dir_path=".gitlab/tinybird",
         ),
+        CICDFile(
+            template=GITLAB_CD_YML,
+            file_name="tinybird-cd.yml",
+            dir_path=".gitlab/tinybird",
+        ),
     ]
 
 

tinybird/tb/modules/create.py

@@ -6,7 +6,7 @@ from typing import Optional, Tuple
 import click
 
 from tinybird.client import TinyB
-from tinybird.prompts import create_prompt, mock_prompt, rules_prompt
+from tinybird.prompts import create_prompt, mock_prompt, readme_prompt, rules_prompt
 from tinybird.tb.modules.cicd import init_cicd
 from tinybird.tb.modules.cli import cli
 from tinybird.tb.modules.common import _generate_datafile, coro, generate_datafile
@@ -88,12 +88,32 @@ async def create(
             click.echo(FeedbackManager.success(message="✓ Scaffolding completed!\n"))
             created_something = True
         result = ""
-        if data or prompt:
+        if (data or prompt) and user_token:
             click.echo(FeedbackManager.highlight(message="\n» Creating resources..."))
             result, created_something = await create_resources(
                 local_client, tb_client, user_token, data, prompt, folder
             )
             click.echo(FeedbackManager.success(message="✓ Done!\n"))
+            if prompt:
+                readme_path = Path(root_folder) / "README.md"
+                if readme_path.exists():
+                    click.echo(FeedbackManager.highlight(message="\n» Updating README.md..."))
+                else:
+                    click.echo(FeedbackManager.highlight(message="\n» Creating README.md..."))
+                    readme_path.touch()
+                llm = LLM(user_token=str(user_token), host=tb_client.host)
+                readme_user_prompt = prompt or ""
+                all_resources_xml = get_resources_xml(project)
+                readme_response = llm.ask(
+                    system_prompt=readme_prompt(
+                        readme_path.read_text(), tb_client.host, tb_client.token, all_resources_xml
+                    ),
+                    prompt=readme_user_prompt,
+                )
+                readme_result = extract_xml(readme_response, "readme")
+                readme_path.write_text(readme_result)
+                click.echo(FeedbackManager.success(message="✓ Done!\n"))
+                created_something = True
 
         if not already_has_cicd(root_folder):
             click.echo(FeedbackManager.highlight(message="\n» Creating CI/CD files for GitHub and GitLab..."))
@@ -390,3 +410,30 @@ def get_context() -> str:
 def save_context(prompt: str, feedback: str):
     context_file = get_context_file()
     context_file.write_text(f"- {prompt}\n{feedback}")
+
+
+def get_resources_xml(project: Project) -> str:
+    folder = project.folder
+    datasource_paths = [
+        Path(folder) / "datasources" / f for f in os.listdir(Path(folder) / "datasources") if f.endswith(".datasource")
+    ]
+    pipes_paths = [
+        Path(folder) / "endpoints" / f for f in os.listdir(Path(folder) / "endpoints") if f.endswith(".pipe")
+    ]
+    resources_xml = "\n".join(
+        [
+            f"<resource><type>{resource_type}</type><name>{resource_name}</name><content>{resource_content}</content></resource>"
+            for resource_type, resource_name, resource_content in [
+                ("datasource", ds.stem, ds.read_text()) for ds in datasource_paths
+            ]
+            + [
+                (
+                    "pipe",
+                    pipe.stem,
+                    pipe.read_text(),
+                )
+                for pipe in pipes_paths
+            ]
+        ]
+    )
+    return resources_xml

tinybird/tb/modules/datafile/fixture.py

@@ -5,7 +5,9 @@ from tinybird.tb.modules.common import format_data_to_ndjson
 
 
 def get_fixture_dir(folder: str) -> Path:
-    return Path(folder) / "fixtures"
+    fixture_dir = Path(folder) / "fixtures"
+    fixture_dir.mkdir(exist_ok=True)
+    return fixture_dir
 
 
 def persist_fixture_sql(fixture_name: str, sql: str, folder: str) -> Path:

tinybird/tb/modules/infra.py

@@ -371,7 +371,7 @@ async def infra_init(
 
     # Create infra directory if it doesn't exist
     infra_dir = Path(f"infra/{cloud_provider}")
-    infra_dir.mkdir(exist_ok=True)
+    infra_dir.mkdir(parents=True, exist_ok=True)
     yaml_path = infra_dir / "k8s.yaml"
     tf_path = infra_dir / "main.tf"
     config_path = infra_dir / "config.json"

{tinybird-0.0.1.dev112.dist-info → tinybird-0.0.1.dev113.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: tinybird
-Version: 0.0.1.dev112
+Version: 0.0.1.dev113
 Summary: Tinybird Command Line Tool
 Home-page: https://www.tinybird.co/docs/cli/introduction.html
 Author: Tinybird

{tinybird-0.0.1.dev112.dist-info → tinybird-0.0.1.dev113.dist-info}/RECORD

@@ -6,7 +6,7 @@ tinybird/context.py,sha256=FfqYfrGX_I7PKGTQo93utaKPDNVYWelg4Hsp3evX5wM,1291
 tinybird/datatypes.py,sha256=XNypumfqNjsvLJ5iNXnbVHRvAJe0aQwI3lS6Cxox-e0,10979
 tinybird/feedback_manager.py,sha256=a_ZhFX2zcB7vRknIcmHKMdQbb0c7TqlTBQ_5hPuWh88,69267
 tinybird/git_settings.py,sha256=Sw_8rGmribEFJ4Z_6idrVytxpFYk7ez8ei0qHULzs3E,3934
-tinybird/prompts.py,sha256=0i4Bzg-60lV6NlrQ1Vu6NZ_2we3GqV3rExu77YfA0V4,33889
+tinybird/prompts.py,sha256=6J-dE0gOSOaIwdEwJUhEQS1Ztllz_qZnpnrv-tDoJWA,35511
 tinybird/sql.py,sha256=C_B81wwv3BsqyXGhF5oTk9DcTUkrp7NwIFqSzd3Dmjc,47854
 tinybird/sql_template.py,sha256=mK0yeRFctbXTAu0VNMjIzoFBJoh9PoniAVgEatA5SG4,99832
 tinybird/sql_template_fmt.py,sha256=KUHdj5rYCYm_rKKdXYSJAE9vIyXUQLB0YSZnUXHeBlY,10196
@@ -15,24 +15,24 @@ tinybird/syncasync.py,sha256=IPnOx6lMbf9SNddN1eBtssg8vCLHMt76SuZ6YNYm-Yk,27761
 tinybird/tornado_template.py,sha256=jjNVDMnkYFWXflmT8KU_Ssbo5vR8KQq3EJMk5vYgXRw,41959
 tinybird/ch_utils/constants.py,sha256=aYvg2C_WxYWsnqPdZB1ZFoIr8ZY-XjUXYyHKE9Ansj0,3890
 tinybird/ch_utils/engine.py,sha256=BZuPM7MFS7vaEKK5tOMR2bwSAgJudPrJt27uVEwZmTY,40512
-tinybird/tb/__cli__.py,sha256=XBYsgERHHC2rSmVZ_I1ovdmeZxmG3you6UQuNA4-qR4,252
+tinybird/tb/__cli__.py,sha256=LaRkkDcDxWMZ18zj4QiJLTrW9enEg_2awfZ1Gc0sO-U,252
 tinybird/tb/cli.py,sha256=H_HaZhkimKgkryYXpBjHfY9Qtg-ZORiONU3psDNpzDk,1135
 tinybird/tb/modules/auth.py,sha256=L1IatO2arRSzys3t8px8xVt8uPWUL5EVD0sFzAV_uVU,9022
 tinybird/tb/modules/build.py,sha256=h5drdmDFX8NHts9dA2Zepao7KSgMAl3DZGyFufVZP78,11085
-tinybird/tb/modules/cicd.py,sha256=k2hCout_N1g_rRAMWo_cf9tAGiJ1Puu5eiTV2DPob20,6939
+tinybird/tb/modules/cicd.py,sha256=A7zJZF9HkJ6NPokplgNjmefMrpUlRbFxBbjMZhq5OTI,7110
 tinybird/tb/modules/cli.py,sha256=sZEYoJVfqN6zaCSN5NQRrzQLXxeJ5nDO7EnFXit9qh8,16157
 tinybird/tb/modules/common.py,sha256=d2kkXrkoMBmh_CirBBgLw1E1_cxKUUB3ZE_Mx1x9tww,81717
 tinybird/tb/modules/config.py,sha256=FqdLpLaKpYubqw3xkB4EX06ufZYDgGRxONR_9i-y-KE,11416
 tinybird/tb/modules/connection.py,sha256=IL095_8ideKM1Ueen3BdsYvJKA05VAdpv7bSQjhXKJo,5354
 tinybird/tb/modules/copy.py,sha256=MAVqKip8_QhOYq99U_XuqSO6hCLJEh5sFtbhcXtI3SI,5802
-tinybird/tb/modules/create.py,sha256=3Yz257QM7c8OgWlVRacnNXFkZPsDQFNLzJSVr83Xe70,14335
+tinybird/tb/modules/create.py,sha256=hIFZeaVKxNij80jKMWT9Pq9M-Uoo2hoUXfb1VdD5H_8,16401
 tinybird/tb/modules/datasource.py,sha256=dNCK9iCR2xPLfwqqwg2ixyE6NuoVEiJU2mBZBmOYrVY,16906
 tinybird/tb/modules/deployment.py,sha256=UIW3W0qKBRk2o4gE8WDjmq9-UkrNZjtkbyKvcQR203k,19515
 tinybird/tb/modules/endpoint.py,sha256=EhVoGAXsFz-83Fiwj1gI-I73iRRvL49d0W81un7hvPE,12080
 tinybird/tb/modules/exceptions.py,sha256=4A2sSjCEqKUMqpP3WI00zouCWW4uLaghXXLZBSw04mY,3363
 tinybird/tb/modules/feedback_manager.py,sha256=7e-O-LyTi_hTln47Y_FuSWerggZQLUGqfTJeYK6D9i4,69479
 tinybird/tb/modules/fmt.py,sha256=qpf9APqKTKL2uphNgdbj4OMVyLkAxZn6dn4eHF99L5g,3553
-tinybird/tb/modules/infra.py,sha256=GA5xnYLlVItPfJu_3_5NIdHQDuyfk2Z71wtcn9NncGA,33189
+tinybird/tb/modules/infra.py,sha256=fnbsfx8paRE8RHPbjdSOiOEvtyQbJ95OrHZuCighgKA,33203
 tinybird/tb/modules/job.py,sha256=956Pj8BEEsiD2GZsV9RKKVM3I_CveOLgS82lykO5ukk,2963
 tinybird/tb/modules/llm.py,sha256=AC0VSphTOM2t-v1_3NLvNN_FIbgMo4dTyMqIv5nniPo,835
 tinybird/tb/modules/llm_utils.py,sha256=nS9r4FAElJw8yXtmdYrx-rtI2zXR8qXfi1QqUDCfxvg,3469
@@ -64,7 +64,7 @@ tinybird/tb/modules/datafile/build_pipe.py,sha256=w-Wd08gZYAEcak9FdBijVfIU2_Wn_P
 tinybird/tb/modules/datafile/common.py,sha256=4pvW92X9BXomaN3-WhQOjvnAHY96O4dTsp4USBdknzk,83192
 tinybird/tb/modules/datafile/diff.py,sha256=-0J7PsBO64T7LOZSkZ4ZFHHCPvT7cKItnJkbz2PkndU,6754
 tinybird/tb/modules/datafile/exceptions.py,sha256=8rw2umdZjtby85QbuRKFO5ETz_eRHwUY5l7eHsy1wnI,556
-tinybird/tb/modules/datafile/fixture.py,sha256=si-9LB-LdKQSWDtVW82xDrHtFfko5bgBG1cvjqqrcPU,1064
+tinybird/tb/modules/datafile/fixture.py,sha256=V3WGfPLIR78el3oCNWNkySWs6LxIufyIM0mDrrT3aWc,1131
 tinybird/tb/modules/datafile/format_common.py,sha256=WaNV4tXrQU5gjV6MJP-5TGqg_Bre6ilNS8emvFl-X3c,1967
 tinybird/tb/modules/datafile/format_datasource.py,sha256=gpRsGnDEMxEo0pIlEHXKvyuwKIpqJJUCN9JRSiDYs_4,6156
 tinybird/tb/modules/datafile/format_pipe.py,sha256=58iSTrJ5lg-IsbpX8TQumQTuZ6UIotMsCIkNJd1M-pM,7418
@@ -81,8 +81,8 @@ tinybird/tb_cli_modules/config.py,sha256=IsgdtFRnUrkY8-Zo32lmk6O7u3bHie1QCxLwgp4
 tinybird/tb_cli_modules/exceptions.py,sha256=pmucP4kTF4irIt7dXiG-FcnI-o3mvDusPmch1L8RCWk,3367
 tinybird/tb_cli_modules/regions.py,sha256=QjsL5H6Kg-qr0aYVLrvb1STeJ5Sx_sjvbOYO0LrEGMk,166
 tinybird/tb_cli_modules/telemetry.py,sha256=Hh2Io8ZPROSunbOLuMvuIFU4TqwWPmQTqal4WS09K1A,10449
-tinybird-0.0.1.dev112.dist-info/METADATA,sha256=qVwK9fWPocmfDDsDhlUcPh61jVOZhCV7vZAgMzLn-xs,1612
-tinybird-0.0.1.dev112.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
-tinybird-0.0.1.dev112.dist-info/entry_points.txt,sha256=LwdHU6TfKx4Qs7BqqtaczEZbImgU7Abe9Lp920zb_fo,43
-tinybird-0.0.1.dev112.dist-info/top_level.txt,sha256=VqqqEmkAy7UNaD8-V51FCoMMWXjLUlR0IstvK7tJYVY,54
-tinybird-0.0.1.dev112.dist-info/RECORD,,
+tinybird-0.0.1.dev113.dist-info/METADATA,sha256=pXBu3TNee7oQ8TTmimVtTCShVvNle6Q26inMsxXIU6o,1612
+tinybird-0.0.1.dev113.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+tinybird-0.0.1.dev113.dist-info/entry_points.txt,sha256=LwdHU6TfKx4Qs7BqqtaczEZbImgU7Abe9Lp920zb_fo,43
+tinybird-0.0.1.dev113.dist-info/top_level.txt,sha256=VqqqEmkAy7UNaD8-V51FCoMMWXjLUlR0IstvK7tJYVY,54
+tinybird-0.0.1.dev113.dist-info/RECORD,,