tukan-python 0.3.0__tar.gz → 0.3.1__tar.gz

{tukan_python-0.3.0/tukan_python.egg-info → tukan_python-0.3.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: tukan_python
-Version: 0.3.0
+Version: 0.3.1
 Summary: SDK de Python para acceder a datos oficiales de México a través de la API de Tukan.
 Author-email: TukanMx <contacto@tukanmx.com>
 License-Expression: MIT
@@ -300,6 +300,43 @@ q.set_table_name("mex_cnbv_cb_orig_by_gender_monthly")
 resultado = q.execute_query()
 ```
 
+### 7. Consultas SQL con `SQLQuery`
+
+Si prefieres escribir SQL directamente, puedes usar la clase `SQLQuery`. Las consultas se ejecutan con el motor Blizzard y la paginación se maneja automáticamente:
+
+```python
+from tukan_python import SQLQuery
+
+sq = SQLQuery(sql="""
+    SELECT
+        END_DATE AS end_date,
+        INSTITUTIONS_REF AS institutions,
+        INSTITUTIONS_NAME AS institutions__name,
+        INDICATOR_REF AS indicator,
+        INDICATOR_NAME AS indicator__name,
+        VALUE as value
+    FROM tukan_db.source_of_truth_full.mex_tukan_retail_sales_by_company
+    WHERE END_DATE = '2022-12-31'
+    LIMIT 100000 OFFSET 0
+""")
+
+resultado = sq.execute()
+print(resultado["df"])
+```
+
+Las tablas disponibles en SQL se encuentran en el esquema `tukan_db.source_of_truth_full`.
+
+#### Guardar una consulta SQL en tu perfil
+
+Puedes guardar tus consultas SQL para acceder a ellas desde la [aplicación web](https://app.tukanmx.com):
+
+```python
+sq = SQLQuery(sql="SELECT * FROM tukan_db.source_of_truth_full.mex_banxico_cf102 LIMIT 100")
+sq.save_sql_query(name="Tipo de cambio FIX", language="es")
+```
+
+Parámetros opcionales: `description`, `tags` (lista de strings).
+
 ## Conceptos clave
 
 ### Tablas

{tukan_python-0.3.0 → tukan_python-0.3.1}/README.md

@@ -272,6 +272,43 @@ q.set_table_name("mex_cnbv_cb_orig_by_gender_monthly")
 resultado = q.execute_query()
 ```
 
+### 7. Consultas SQL con `SQLQuery`
+
+Si prefieres escribir SQL directamente, puedes usar la clase `SQLQuery`. Las consultas se ejecutan con el motor Blizzard y la paginación se maneja automáticamente:
+
+```python
+from tukan_python import SQLQuery
+
+sq = SQLQuery(sql="""
+    SELECT
+        END_DATE AS end_date,
+        INSTITUTIONS_REF AS institutions,
+        INSTITUTIONS_NAME AS institutions__name,
+        INDICATOR_REF AS indicator,
+        INDICATOR_NAME AS indicator__name,
+        VALUE as value
+    FROM tukan_db.source_of_truth_full.mex_tukan_retail_sales_by_company
+    WHERE END_DATE = '2022-12-31'
+    LIMIT 100000 OFFSET 0
+""")
+
+resultado = sq.execute()
+print(resultado["df"])
+```
+
+Las tablas disponibles en SQL se encuentran en el esquema `tukan_db.source_of_truth_full`.
+
+#### Guardar una consulta SQL en tu perfil
+
+Puedes guardar tus consultas SQL para acceder a ellas desde la [aplicación web](https://app.tukanmx.com):
+
+```python
+sq = SQLQuery(sql="SELECT * FROM tukan_db.source_of_truth_full.mex_banxico_cf102 LIMIT 100")
+sq.save_sql_query(name="Tipo de cambio FIX", language="es")
+```
+
+Parámetros opcionales: `description`, `tags` (lista de strings).
+
 ## Conceptos clave
 
 ### Tablas

{tukan_python-0.3.0 → tukan_python-0.3.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "tukan_python"
-version = "0.3.0"
+version = "0.3.1"
 description = "SDK de Python para acceder a datos oficiales de México a través de la API de Tukan."
 authors = [
     { name = "TukanMx", email = "contacto@tukanmx.com" }

{tukan_python-0.3.0 → tukan_python-0.3.1}/tukan_python/query.py

@@ -287,6 +287,39 @@ class SQLQuery:
         instance._sql = sql
         return instance
 
+    def save_sql_query(
+        self,
+        name: str,
+        language: str = "es",
+        description: str = "",
+        tags: Optional[list[str]] = None,
+    ) -> dict:
+        """Save this SQL query to the user's profile.
+
+        Args:
+            name: Display name for the saved query.
+            language: Language code (default "es").
+            description: Optional description.
+            tags: Optional list of tag strings.
+
+        Returns:
+            API response dict.
+        """
+        body = {
+            "name": name,
+            "description": description,
+            "language": language,
+            "query": {
+                "name": name,
+                "raw_sql": self._encode_sql(),
+                "language": language,
+                "retrieve_engine": "blizzard",
+                "use_vertical_mode": False,
+            },
+            "tags": tags if tags is not None else [],
+        }
+        return self.tukan.execute_post_operation(body, "visualizations/query/")
+
     def __str__(self) -> str:
         return f"SQLQuery(sql={self._sql!r})"
 

{tukan_python-0.3.0 → tukan_python-0.3.1}/tukan_python/tukan.py

@@ -198,6 +198,53 @@ class Tukan:
         return df
 
 
+    def get_catalog_tables(
+        self, page: int = 1, page_size: int = 40, language: str = "es"
+    ) -> list[dict]:
+        """List available catalog tables.
+
+        Args:
+            page: Page number (1-indexed).
+            page_size: Number of results per page.
+            language: Language code ('es' or 'en').
+
+        Returns:
+            List of catalog table dicts.
+        """
+        url = f"{self.env}data/catalogue_table/"
+        headers = {"Authorization": f"token {self.token}"}
+        params = {
+            "page_size": page_size,
+            "current": page,
+            "api": "data",
+            "resource": "catalogue_table",
+            "language": language,
+        }
+        request_partial = wrapped_partial(
+            requests.get, url=url, headers=headers, params=params, timeout=30
+        )
+        response = self.persistent_request(request_partial)
+        if response.status_code >= 300:
+            raise Exception(f"Failed to list catalog tables: {response.text}")
+        return response.json()
+
+    def export_catalog_table(self, catalogue_id: str) -> pd.DataFrame:
+        """Export a catalog table as a DataFrame.
+
+        Args:
+            catalogue_id: The catalog table ID to export.
+
+        Returns:
+            DataFrame with the catalog table data.
+        """
+        url = f"{self.env}data/retrieve_json_catalogue/{catalogue_id}/{self.token}/"
+        request_partial = wrapped_partial(requests.get, url=url, timeout=30)
+        response = self.persistent_request(request_partial)
+        if response.status_code >= 300:
+            raise Exception(f"Failed to export catalog table: {response.text}")
+        data = response.json()
+        return pd.DataFrame(data)
+
     def sql(self, query: str) -> dict:
         """Execute a raw SQL query against the Tukan API.
 

{tukan_python-0.3.0 → tukan_python-0.3.1/tukan_python.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: tukan_python
-Version: 0.3.0
+Version: 0.3.1
 Summary: SDK de Python para acceder a datos oficiales de México a través de la API de Tukan.
 Author-email: TukanMx <contacto@tukanmx.com>
 License-Expression: MIT
@@ -300,6 +300,43 @@ q.set_table_name("mex_cnbv_cb_orig_by_gender_monthly")
 resultado = q.execute_query()
 ```
 
+### 7. Consultas SQL con `SQLQuery`
+
+Si prefieres escribir SQL directamente, puedes usar la clase `SQLQuery`. Las consultas se ejecutan con el motor Blizzard y la paginación se maneja automáticamente:
+
+```python
+from tukan_python import SQLQuery
+
+sq = SQLQuery(sql="""
+    SELECT
+        END_DATE AS end_date,
+        INSTITUTIONS_REF AS institutions,
+        INSTITUTIONS_NAME AS institutions__name,
+        INDICATOR_REF AS indicator,
+        INDICATOR_NAME AS indicator__name,
+        VALUE as value
+    FROM tukan_db.source_of_truth_full.mex_tukan_retail_sales_by_company
+    WHERE END_DATE = '2022-12-31'
+    LIMIT 100000 OFFSET 0
+""")
+
+resultado = sq.execute()
+print(resultado["df"])
+```
+
+Las tablas disponibles en SQL se encuentran en el esquema `tukan_db.source_of_truth_full`.
+
+#### Guardar una consulta SQL en tu perfil
+
+Puedes guardar tus consultas SQL para acceder a ellas desde la [aplicación web](https://app.tukanmx.com):
+
+```python
+sq = SQLQuery(sql="SELECT * FROM tukan_db.source_of_truth_full.mex_banxico_cf102 LIMIT 100")
+sq.save_sql_query(name="Tipo de cambio FIX", language="es")
+```
+
+Parámetros opcionales: `description`, `tags` (lista de strings).
+
 ## Conceptos clave
 
 ### Tablas