garf-executors 0.2.3__py3-none-any.whl → 1.0.2__py3-none-any.whl

garf_executors/workflow.py

@@ -11,86 +11,15 @@
 # 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.
-from __future__ import annotations
 
-import os
-import pathlib
 
-import pydantic
-import smart_open
-import yaml
+import warnings
 
-from garf_executors.execution_context import ExecutionContext
+from garf.executors.workflow import *
 
-
-class QueryPath(pydantic.BaseModel):
-  """Path file with query."""
-
-  path: str
-
-
-class QueryDefinition(pydantic.BaseModel):
-  """Definition of a query."""
-
-  query: Query
-
-
-class Query(pydantic.BaseModel):
-  """Query elements.
-
-  Attributes:
-    text: Query text.
-    title: Name of the query.
-  """
-
-  text: str
-  title: str
-
-
-class ExecutionStep(ExecutionContext):
-  """Common context for executing one or more queries.
-
-  Attributes:
-    fetcher: Name of a fetcher to get data from API.
-    alias: Optional alias to identify execution step.
-    queries: Queries to run for a particular fetcher.
-    context: Execution context for queries and fetcher.
-  """
-
-  fetcher: str | None = None
-  alias: str | None = None
-  queries: list[QueryPath | QueryDefinition] | None = None
-
-  @property
-  def context(self) -> ExecutionContext:
-    return ExecutionContext(
-      writer=self.writer,
-      writer_parameters=self.writer_parameters,
-      query_parameters=self.query_parameters,
-      fetcher_parameters=self.fetcher_parameters,
-    )
-
-
-class Workflow(pydantic.BaseModel):
-  """Orchestrates execution of queries for multiple fetchers.
-
-  Attributes:
-    steps: Contains one or several fetcher executions.
-  """
-
-  steps: list[ExecutionStep]
-
-  @classmethod
-  def from_file(cls, path: str | pathlib.Path | os.PathLike[str]) -> Workflow:
-    """Builds workflow from local or remote yaml file."""
-    with smart_open.open(path, 'r', encoding='utf-8') as f:
-      data = yaml.safe_load(f)
-    return Workflow(steps=data.get('steps'))
-
-  def save(self, path: str | pathlib.Path | os.PathLike[str]) -> str:
-    """Saves workflow to local or remote yaml file."""
-    with smart_open.open(path, 'w', encoding='utf-8') as f:
-      yaml.dump(
-        self.model_dump(exclude_none=True).get('steps'), f, encoding='utf-8'
-      )
-    return f'Workflow is saved to {str(path)}'
+warnings.warn(
+  "The 'garf_executors' namespace is deprecated. "
+  "Please use 'garf.executors' instead.",
+  DeprecationWarning,
+  stacklevel=2,
+)

{garf_executors-0.2.3.dist-info → garf_executors-1.0.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: garf-executors
-Version: 0.2.3
+Version: 1.0.2
 Summary: Executes queries against API and writes data to local/remote storage.
 Author-email: "Google Inc. (gTech gPS CSE team)" <no-reply@google.com>, Andrei Markin <andrey.markin.ppc@gmail.com>
 License: Apache 2.0
@@ -17,8 +17,8 @@ Classifier: Operating System :: OS Independent
 Classifier: License :: OSI Approved :: Apache Software License
 Requires-Python: >=3.9
 Description-Content-Type: text/markdown
-Requires-Dist: garf-core
-Requires-Dist: garf-io
+Requires-Dist: garf-core>=1.0.0
+Requires-Dist: garf-io>=1.0.0
 Requires-Dist: pyyaml
 Requires-Dist: pydantic
 Requires-Dist: opentelemetry-api
@@ -68,8 +68,14 @@ garf <QUERIES> --source <API_SOURCE> \
 where
 
 * `<QUERIES>`- local or remote path(s) to files with queries.
-* `<API_SOURCE>`- type of API to use. Based on that the appropriate report fetcher will be initialized.
-* `<OUTPUT_TYPE>` - output supported by [`garf-io` library](../garf_io/README.md).
+* `source`- type of API to use. Based on that the appropriate report fetcher will be initialized. Explore supported APIs [here](https://google.github.io/garf/fetchers/overview/)
+* `output` - output supported by [`garf-io` library](https://google.github.io/garf/usage/writers/).
 
 If your report fetcher requires additional parameters you can pass them via key value pairs under `--source.` argument, i.e.`--source.regionCode='US'` - to get data only from *US*.
 > Concrete `--source` parameters are dependent on a particular report fetcher and should be looked up in a documentation for this fetcher.
+
+## Documentation
+
+Explore full documentation working with `garf-executors`
+
+* [Documentation](https://google.github.io/garf/usage/executors/)

garf_executors-1.0.2.dist-info/RECORD

@@ -0,0 +1,42 @@
+garf/executors/__init__.py,sha256=dO6T9Z9Q5zc3BszqaTQE8fK5weyV_RTmj8ElV0mUFhQ,1941
+garf/executors/api_executor.py,sha256=bLhG9FLgAfdO16BW22YhAq0SXY8c-WuNW13e6bUu_VE,4380
+garf/executors/bq_executor.py,sha256=f5jQllFAE3b_ajQlosZfecovnrIDfyOAO-k8_AjzRqQ,5774
+garf/executors/config.py,sha256=w5g9EYabPtK-6CPl3G87owUvBiqi0_r_aeAwISpK-zw,1720
+garf/executors/exceptions.py,sha256=U_7Q2ZMOUf89gzZd2pw7y3g7i1NeByPPKfpZ3q7p3ZU,662
+garf/executors/execution_context.py,sha256=us_S-x2jsJOBo4Vm78DhCgcgnu_HPc-f9-q_XI_eowU,3840
+garf/executors/executor.py,sha256=SpPONsYHO49WbZ2HRjTKujrNH64BbrSfKcZSn4Dcd6o,3830
+garf/executors/fetchers.py,sha256=Jtdl9A2G4xEM-pnUg_fWv3cltcMpM7JjdTcLeJK5AVY,2604
+garf/executors/garf_pb2.py,sha256=mYvBYcAnZtyDflXGN2GZLM2KM0Nv9hoJs55zfQU_l1o,2564
+garf/executors/garf_pb2_grpc.py,sha256=w8D_r3wpj1ZZstkIFogY679-lSCcL2iZQ4QLO8IfToY,3359
+garf/executors/query_processor.py,sha256=xCTkm2V0iMfsjJ0ydwyVRFFiZh1ilhJKzglYlReRKAk,2250
+garf/executors/sql_executor.py,sha256=Z1E7aL9HiYcqfUJMuESlu4iZjVy5hNMvplu2hLotK9I,4780
+garf/executors/telemetry.py,sha256=wLWAdJZmGinffIMv5FZNKaAUusgACTvokwhMFz2UCQ0,747
+garf/executors/workflow.py,sha256=WFsTV916mw_DsWttrLc8tNnDl0vwJAQwVlIHRdNaNDw,3007
+garf/executors/entrypoints/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+garf/executors/entrypoints/cli.py,sha256=8vk8jElesqqn0q2Te3v6W1V-kts-28N5sncovaZqq3o,6699
+garf/executors/entrypoints/grpc_server.py,sha256=__y2uR2pwlnYy1YFm-2EjFYxBKZmN1a9XY9MNsfrhag,2295
+garf/executors/entrypoints/server.py,sha256=vXGz-f7C1aweaMNJTJEjZLIg42d0T01HPG_lxlj-FPs,3472
+garf/executors/entrypoints/tracer.py,sha256=-UM1RNtW90jFsQiavVzhIWzB3cOCTcCwc6v7YIVflDk,1912
+garf/executors/entrypoints/utils.py,sha256=5XiGR2IOxdzAOY0lEWUeUV7tIpKBGRnQaIwBYvzQB7c,4337
+garf_executors/__init__.py,sha256=5Ol67ktUcC0q5d5pGblYfdlAsraJC-Gcr2U0uCN6rSs,772
+garf_executors/api_executor.py,sha256=lmrPn6aheryM2jLRL2enU8GuKVUod3kEVkMYgjXn5EM,785
+garf_executors/bq_executor.py,sha256=wQ8pd4d6dMByHtYl_i-FbebPKO5WRcvC_y9asG8H3Zk,784
+garf_executors/config.py,sha256=3MXFdB3HAAdiBM58GmFA6HM6LcaA28mskUd5XUvJ5QM,779
+garf_executors/exceptions.py,sha256=iBnO93AZRlmy_lo67ufQ67kv2FpBemu9VgDbwZx5b_s,783
+garf_executors/execution_context.py,sha256=l5l5q8gPFNppOJ8q8TZfaaIEXmashTDu4denoGwMkpU,790
+garf_executors/executor.py,sha256=0OPHePl_UG5k5o8UDid0HPu5QBCHnKFKvKv7vyx0LwE,781
+garf_executors/fetchers.py,sha256=ayRzEp2-JvRhdkEmec10IKwX5SF25t6o03H1b9t5K3U,781
+garf_executors/sql_executor.py,sha256=qhk5nZEq2a8QBvriiMWCE18xTQ29CSBQ7YPZ4Mr5DNA,785
+garf_executors/telemetry.py,sha256=ncQ39dAE1tG0xKcyPAgEW8__0MhCSiBphZhisXeWp9k,782
+garf_executors/workflow.py,sha256=vsxfjJVePu1NtWnVhCitMP_IZ-fcc9_H4fZS818_b70,781
+garf_executors/entrypoints/__init__.py,sha256=DNA_m3MeyN10t8iSvhWjdlksR1GgIr-Wmy4Yuba5S3M,808
+garf_executors/entrypoints/cli.py,sha256=Jaq46VnzltGMqJq9U6_3E3e_sC21VOon52gPYIrI8nY,812
+garf_executors/entrypoints/grcp_server.py,sha256=HiYsfk31OgkPA4jcED3htJGidkRZH5NQIpkncVMCStk,820
+garf_executors/entrypoints/server.py,sha256=JZCklhqx74PIhc4GIoOr2nNZz9n7QCfIm_vGyd3Q3dQ,815
+garf_executors/entrypoints/tracer.py,sha256=JlDSgeDP0Q5Lk_pZLASDXPgZCPaKkWqZgaWOQ7JB-Bs,815
+garf_executors/entrypoints/utils.py,sha256=iF-LBfKjrAhEW6HShh69RCPWVPC4Rf8iV5JEYSMhsx0,814
+garf_executors-1.0.2.dist-info/METADATA,sha256=zNOfNeIWJiEoaWz2ONVf0gQeVRc5q6DM8CxnUxmoB90,3303
+garf_executors-1.0.2.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+garf_executors-1.0.2.dist-info/entry_points.txt,sha256=0IBZun3_hC4HYU-1krlbjTArZym3phu4jxYXs809ilw,61
+garf_executors-1.0.2.dist-info/top_level.txt,sha256=UaHdWdgQhbiHyRzpYC-vW3Q7pdgbxXvTTBvDA655Jq4,20
+garf_executors-1.0.2.dist-info/RECORD,,

garf_executors-1.0.2.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+garf = garf.executors.entrypoints.cli:main

{garf_executors-0.2.3.dist-info → garf_executors-1.0.2.dist-info}/top_level.txt

@@ -1 +1,2 @@
+garf
 garf_executors

garf_executors-0.2.3.dist-info/RECORD

@@ -1,24 +0,0 @@
-garf_executors/__init__.py,sha256=wZdLw0WyAGEK1y0Fdagvdd5xOWNKaPvL95yuaYziIWE,1941
-garf_executors/api_executor.py,sha256=IKYI1TK2HI2njxw7_X9n78wAQ1briAXxbA15Ybmt6nA,4295
-garf_executors/bq_executor.py,sha256=HKFBg4PhIaKM_SvjQy-ZbP7AsrsAF1FIj_w9gRqdICA,5756
-garf_executors/config.py,sha256=rZTAuBEa-Loi3DSamXFTjFQXHdeYJv71WOEbLLeo3l4,1721
-garf_executors/exceptions.py,sha256=U_7Q2ZMOUf89gzZd2pw7y3g7i1NeByPPKfpZ3q7p3ZU,662
-garf_executors/execution_context.py,sha256=WhHoN60vyeBUJbdjtOEZC1vUEyLwnIzBHbhT8co3yhs,3850
-garf_executors/executor.py,sha256=tobjdlOaAsc-nKLFSW-3qib5-ca6aHs5iw3Gn0sD72Y,3762
-garf_executors/fetchers.py,sha256=0bYurZs5jzxfGP9BgDnifdM6yRFvyCtKO-i3hFb5T5A,2605
-garf_executors/garf_pb2.py,sha256=mYvBYcAnZtyDflXGN2GZLM2KM0Nv9hoJs55zfQU_l1o,2564
-garf_executors/garf_pb2_grpc.py,sha256=w8D_r3wpj1ZZstkIFogY679-lSCcL2iZQ4QLO8IfToY,3359
-garf_executors/sql_executor.py,sha256=80WiuNBBWQz1y19LmWrzSk6auFFqh6YHBPTkFAGIhMs,4681
-garf_executors/telemetry.py,sha256=P75klGEoYgJ_-pR-izUIQ7B88ufskQ4vmW1rETg63Nc,747
-garf_executors/workflow.py,sha256=9Hkv0NgNyV5_xkkCTS6nsDVqtCmHfbqLQvdaIzFBrLU,2614
-garf_executors/entrypoints/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-garf_executors/entrypoints/cli.py,sha256=Kei2Tqdw1syPKhbeK5u-1G72hXgmo1arXmxio150jPE,6006
-garf_executors/entrypoints/grpc_server.py,sha256=zP9C-dStbElWkb0T_IcIAcBxmA9Wl4GTWytUcrC_7Xg,2296
-garf_executors/entrypoints/server.py,sha256=FbemRjrGDgpr51iAMXdvTXlP1OG7Rc5i5M55Prw0wXg,3473
-garf_executors/entrypoints/tracer.py,sha256=VylQMIXOsRLuT3UlFwjRy8GJiPUI6zohUXiGX_DcE4g,1912
-garf_executors/entrypoints/utils.py,sha256=5XiGR2IOxdzAOY0lEWUeUV7tIpKBGRnQaIwBYvzQB7c,4337
-garf_executors-0.2.3.dist-info/METADATA,sha256=96n_J13NrBFbfz2-fVYo0KlD5p9r7qO8AQ3R_K2V710,3055
-garf_executors-0.2.3.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-garf_executors-0.2.3.dist-info/entry_points.txt,sha256=LskWNFIw8j0WJuI18-32OZrlASXAMg1XtrRYwsKBz2E,61
-garf_executors-0.2.3.dist-info/top_level.txt,sha256=sP4dCXOENPn1hDFAunjMV8Js4NND_KGeO_gQWuaT0EY,15
-garf_executors-0.2.3.dist-info/RECORD,,

garf_executors-0.2.3.dist-info/entry_points.txt

@@ -1,2 +0,0 @@
-[console_scripts]
-garf = garf_executors.entrypoints.cli:main