Merge pull request #5 from openwurl/version-1.1.0

Version 1.1.0

README.rst

@@ -1,9 +1,8 @@
 boto3-helpers
 =============
 
-This is the documentation for the ``boto3_helpers`` package, a Python library that
-aims to provide a smoother interface for some of the functions in the AWS
-`boto3 <https://github.com/boto/boto3>`_ package.
+``boto3_helpers`` is a Python library that aims to provide a smoother interface for
+some of the functions in the AWS `boto3 <https://github.com/boto/boto3>`_ package.
 
 You know how to install it:
 
@@ -63,5 +62,7 @@ This package provides helper functions for several similar actions in AWS, such
 * Paging through S3 listings
 * Updating items in DynamoDB
 * Assuming roles with STS
+* Sending and deleting messages with SQS
+* Pulling metric data from CloudWatch
 
-See the `full documentation <https://boto3-helpers.readthedocs.io>`_.
+See the `latest docs <https://boto3-helpers.readthedocs.io>`_ for more. 

boto3_helpers/cloudwatch.py

@@ -39,19 +39,19 @@ def yield_metric_data(
 
     .. code-block:: python
 
-        from boto3_helpers.cloudwatch import yield_metric_data
         from datetime import datetime, timezone
+        from boto3_helpers.cloudwatch import yield_metric_data
 
         for dt, value in yield_metric_data(
             'AWS/S3',
             'NumberOfObjects',
             {'StorageType': 'AllStorageTypes', 'BucketName': 'example-bucket'},
             86400,
             'Maximum',
-            datetime.now(2022, 9, 1, 0, 0, 0, timezone.utc),
-            datetime.now(2022, 9, 16, 0, 0, 0, timezone.utc),
+            datetime(2022, 9, 1, 0, 0, 0, timezone.utc),
+            datetime(2022, 9, 16, 0, 0, 0, timezone.utc),
         ):
-            print(dt.isoformat(), value, sep='\t')
+            print(dt.isoformat(), value, sep=' ')
 
     This function is designed to simplify the common case of pulling all data for a
     single metric, which is cumbersome with the normal CloudWatch ``get_metric_data``

boto3_helpers/events.py

@@ -50,7 +50,7 @@ def describe_rule_with_targets(*, events_client=None, **kwargs):
                 rule_data['Arn'],
                 rule_data['ScheduleExpression'],
                 target['Arn'],
-                sep='\t'
+                sep=' '
             )
 
     .. note::
@@ -98,7 +98,7 @@ def yield_rules_by_target(*, events_client=None, **kwargs):
                 rule_data['Arn'],
                 rule_data['ScheduleExpression'],
                 len(rule_data['Targets']),
-                sep='\t'
+                sep=' '
             )
 
     .. note::
@@ -152,7 +152,7 @@ def yield_rules_with_targets(*, events_client=None, **kwargs):
                 rule_data['Name'],
                 rule_data['ScheduleExpression'],
                 len(rule_data['Targets']),
-                sep='\t'
+                sep=' '
             )
 
     .. note::

setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = boto3-helpers
-version = 1.0.0
+version = 1.1.0
 description = Helper utilities for boto3
 long_description = file: README.rst
 long_description_content_type = text/x-rst