pycarlo 0.12.18__py3-none-any.whl → 0.12.64__py3-none-any.whl

{pycarlo-0.12.18.dist-info → pycarlo-0.12.64.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pycarlo
-Version: 0.12.18
+Version: 0.12.64
 Summary: Monte Carlo's Python SDK
 Home-page: https://www.montecarlodata.com/
 Author: Monte Carlo Data, Inc
@@ -143,7 +143,65 @@ print(client(mutation))
 
 ### Examples
 
-We have [a few examples here you can reference](./examples).
+#### Circuit Breaker Example
+
+```python
+from pycarlo.core import Client, Session
+from pycarlo.features.circuit_breakers import CircuitBreakerService
+
+# Example from our test.snowflake account.
+endpoint = "https://api.dev.getmontecarlo.com/graphql"
+
+service = CircuitBreakerService(
+    mc_client=Client(Session(mcd_profile="test-snow", endpoint=endpoint)), print_func=print
+)
+in_breach = service.trigger_and_poll(rule_uuid="87872875-fe80-4963-8ab0-c04397a6daae")
+print("That can't be good. Our warehouse is broken." if in_breach else "Go, go, go!.")
+```
+
+#### Insight Upload Example
+
+```python
+from pathlib import Path
+
+import boto3
+import requests
+
+from pycarlo.core import Client, Query
+
+MC_CLIENT = Client()
+S3_CLIENT = boto3.client("s3")
+
+
+def upload_insights_to_s3(
+    destination_bucket: str,
+    desired_file_extension: str = ".csv",
+) -> None:
+    """
+    Example function for listing all insights in an account, and uploading any available
+    to S3 as a CSV.
+    """
+    list_insights_query = Query()
+    list_insights_query.get_insights()
+    for insight in MC_CLIENT(list_insights_query).get_insights:
+        report_name = str(Path(insight.name).with_suffix(desired_file_extension))
+
+        if insight.available:
+            report_url_query = Query()
+            report_url_query.get_report_url(insight_name=insight.name, report_name=report_name)
+            report_url = MC_CLIENT(report_url_query).get_report_url.url
+
+            print(f"Uploading {report_name} to {destination_bucket}.")
+            S3_CLIENT.upload_fileobj(
+                Fileobj=requests.get(url=report_url, stream=True).raw,
+                Bucket=destination_bucket,
+                Key=report_name,
+            )
+
+
+if __name__ == "__main__":
+    upload_insights_to_s3(destination_bucket="<BUCKET-NAME>")
+```
 
 See [Monte Carlo's API reference](https://apidocs.getmontecarlo.com/) for all supported queries and
 mutations.
@@ -232,10 +290,6 @@ raising an error. This allows older SDK versions to continue working when new fe
 
 To avoid warnings and ensure full feature support, keep your SDK updated to the latest version.
 
-## Contributing
-
-See [CONTRIBUTING.md](./CONTRIBUTING.md) for details.
-
 ## References
 
 - Monte Carlo App: <https://getmontecarlo.com>
@@ -246,4 +300,4 @@ See [CONTRIBUTING.md](./CONTRIBUTING.md) for details.
 
 ## License
 
-Apache 2.0 - See the [LICENSE](./LICENSE) for more information.
+Apache 2.0 - See the [Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0) for more information.

{pycarlo-0.12.18.dist-info → pycarlo-0.12.64.dist-info}/RECORD

@@ -38,11 +38,11 @@ pycarlo/features/user/queries.py,sha256=m97RvM0oiBlrU5xmOwe_JJ5N0G0NG5hIOeyQqN2O
 pycarlo/features/user/service.py,sha256=DHkhuonySaHro07NTd0YNe3cNkDk62CiRTY77dhVaMs,2890
 pycarlo/lib/README.md,sha256=CVVrPPgje7pkXNNsPvwLSeUOm5aktb22MlttmoxX08k,1677
 pycarlo/lib/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-pycarlo/lib/schema.json,sha256=zmXlnBKJcydi72WMc5L3jkHXFB6RMSqFCiO77z_SjCI,6605810
-pycarlo/lib/schema.py,sha256=2zNqYgWxNfQIw81-Xb1o5buAplNtGCakNcr4xluGj2E,2871673
+pycarlo/lib/schema.json,sha256=YIhDLzj5Ec0iAOF_sjs4X-4MQp-ik_kT0wM8Yhx1U34,6792739
+pycarlo/lib/schema.py,sha256=LyxaCs49TR-mhULyegA4gbTySAMGA_02wOdtzx_ZNag,2938860
 pycarlo/lib/types.py,sha256=lGOrm5Qm-SieDAkOkVOFSgyUJYGOjKnea961AD9Dv6s,2404
-pycarlo-0.12.18.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-pycarlo-0.12.18.dist-info/METADATA,sha256=a4BpakA2kOIhQlsscluRvYuqwNYuWGhfqLMrX3GEee0,8718
-pycarlo-0.12.18.dist-info/WHEEL,sha256=iAkIy5fosb7FzIOwONchHf19Qu7_1wCWyFNR5gu9nU0,91
-pycarlo-0.12.18.dist-info/top_level.txt,sha256=TIE04H4pgzGaFxAB-gvkmVAUOAoHxxFfhnEcpuQ5bF4,8
-pycarlo-0.12.18.dist-info/RECORD,,
+pycarlo-0.12.64.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+pycarlo-0.12.64.dist-info/METADATA,sha256=Zcnya5JXmJbdDCrFeOxHB-zD_PP_j9kFgLrP6ktWGOE,10431
+pycarlo-0.12.64.dist-info/WHEEL,sha256=iAkIy5fosb7FzIOwONchHf19Qu7_1wCWyFNR5gu9nU0,91
+pycarlo-0.12.64.dist-info/top_level.txt,sha256=TIE04H4pgzGaFxAB-gvkmVAUOAoHxxFfhnEcpuQ5bF4,8
+pycarlo-0.12.64.dist-info/RECORD,,