Metadata-Version: 2.1
Name: pendant
Version: 0.2.0
Summary: Python 3.6+ library for submitting to AWS Batch interactively.
Home-page: https://github.com/clintval/pendant
Author: clintval
Author-email: valentine.clint@gmail.com
License: MIT
Download-URL: https://github.com/clintval/pendant/archive/v0.2.0.tar.gz
Project-URL: Documentation, https://pendant.readthedocs.io
Project-URL: Issue-Tracker, https://github.com/clintval/pendant/issues
Description: # pendant
        
        [![Testing Status](https://travis-ci.org/clintval/pendant.svg?branch=master)](https://travis-ci.org/clintval/pendant)
        [![codecov](https://codecov.io/gh/clintval/pendant/branch/master/graph/badge.svg)](https://codecov.io/gh/clintval/pendant)
        [![Documentation Build Status](https://readthedocs.org/projects/pendant/badge/?version=latest)](https://pendant.readthedocs.io/en/latest/?badge=latest)
        [![PyPi Release](https://badge.fury.io/py/pendant.svg)](https://badge.fury.io/py/pendant)
        [![Python Versions](https://img.shields.io/pypi/pyversions/pendant.svg)](https://pypi.python.org/pypi/pendant/)
        [![MyPy Checked](http://www.mypy-lang.org/static/mypy_badge.svg)](http://mypy-lang.org/)
        [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)
        
        Python 3.6+ library for submitting to AWS Batch interactively.
        
        ```bash
        ❯ pip install pendant
        ```
        
        Features:
        
        - Submit Batch jobs
        
        Read the documentation at: [pendant.readthedocs.io](https://pendant.readthedocs.io/en/latest/)
        
        
        ## End-to-end Example
        
        The principle object for deploying jobs to AWS Batch is the Batch job definition.
        Every Batch job definition has a name, parameters, and some form of optional parameter validation.
        
        ```python
        from pendant.aws.batch import JobDefinition
        from pendant.aws.s3 import S3Uri
        from pendand.aws.exception import S3ObjectNotFoundError
        
        class DemoJobDefinition(JobDefinition):
            """A Batch job definition for demonstrating our API.
        
            Args:
                input_object: The S3 URI for the input object.
        
            """
            def __init__(self, input_object: S3Uri):
                self.input_object = input_object
        
            @property
            def name(self) -> str:
                """Return the job definition name."""
                return 'demo-job'
        
            def validate(self) -> None:
                """Validate this parameterized job definition."""
                if not self.input_object.object_exists():
                    raise S3ObjectNotFoundError(f'S3 object does not exist: {self.input_object}')
        ```
        
        We can now wrap the parameterized job definition in a Batch job and set a specific revision.
        
        ```python
        from pendant.aws.batch import BatchJob
        
        definition = DemoJobDefinition(input_object='s3://bucket/object')
        definition.at_revision('6')
        
        job = BatchJob(definition)
        ```
        
        Submitting this Batch job is easy, and introspection can be performed immediately:
        
        ```python
        response = job.submit(queue='prod')
        ```
        
        When the job is in a `RUNNING` state we can access the job's Cloudwatch logs:
        
        ```python
        for log_event in job.log_stream_events():
            print(log_event)
        """
        LogEvent(timestamp="1543809952329", message="You have started up this demo job", ingestion_time="1543809957080")
        LogEvent(timestamp="1543809955437", message="Configuration, we are loading from...", ingestion_time="1543809957080")
        LogEvent(timestamp="1543809955437", message="Defaulting to approximate values", ingestion_time="1543809957080")
        LogEvent(timestamp="1543809955437", message="Setting up logger, nothing to see here", ingestion_time="1543809957080")
        """
        ```
        
        And if we must, we can cancel the job as long as we provide a reason:
        
        ```python
        job.terminate(reason='I was just testing!')
        ```
Keywords: AWS Batch job submission
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Description-Content-Type: text/markdown
