chalice

===========
AWS Chalice
===========

.. image:: https://img.shields.io/pypi/v/chalice.svg?style=flat
   :target: https://pypi.python.org/pypi/chalice/
   :alt: Package Version

.. image:: https://img.shields.io/pypi/pyversions/chalice.svg?style=flat
   :target: https://pypi.python.org/pypi/chalice/
   :alt: Python Versions

.. image:: https://readthedocs.org/projects/chalice/badge/?version=latest
   :target: https://aws.github.io/chalice/?badge=latest
   :alt: Documentation Status

.. image:: https://img.shields.io/pypi/l/chalice.svg?style=flat
   :target: https://github.com/aws/chalice/blob/master/LICENSE
   :alt: License

.. image:: https://aws.github.io/chalice/_static/img/chalice-logo-whitespace.png
   :target: https://aws.github.io/chalice/
   :alt: Chalice Logo


Chalice is a framework for writing serverless apps in Python. It allows
you to quickly create and deploy applications that use AWS Lambda.  It provides:

* A command line tool for creating, deploying, and managing your app
* A decorator based API for integrating with Amazon API Gateway, Amazon S3,
  Amazon SNS, Amazon SQS, and other AWS services.
* Automatic IAM policy generation


You can create Rest APIs:

.. code-block:: python

    from chalice import Chalice

    app = Chalice(app_name="helloworld")

    @app.route("/")
    def index():
        return {"hello": "world"}

Tasks that run on a periodic basis:

.. code-block:: python

    from chalice import Chalice, Rate

    app = Chalice(app_name="helloworld")

    # Automatically runs every 5 minutes
    @app.schedule(Rate(5, unit=Rate.MINUTES))
    def periodic_task(event):
        return {"hello": "world"}


You can connect a lambda function to an S3 event:

.. code-block:: python

    from chalice import Chalice

    app = Chalice(app_name="helloworld")

    # Whenever an object is uploaded to "mybucket"
    # this lambda function will be invoked.

    @app.on_s3_event(bucket="mybucket")
    def handler(event):
        print(
            f"Object uploaded for bucket: {event.bucket}, key: {event.key}"
        )

As well as an SQS queue:

.. code-block:: python

    from chalice import Chalice

    app = Chalice(app_name="helloworld")

    # Invoke this lambda function whenever a message
    # is sent to the ``my-queue-name`` SQS queue.

    @app.on_sqs_message(queue="my-queue-name")
    def handler(event):
        for record in event:
            print(f"Message body: {record.body}")


And several other AWS resources.

Once you've written your code, you just run ``chalice deploy``
and Chalice takes care of deploying your app.

::

    $ chalice deploy
    ...
    https://endpoint/api

    $ curl https://endpoint/api
    {"hello": "world"}

Up and running in less than 30 seconds.
Give this project a try and share your feedback with us here on GitHub.

The documentation is available
`here <https://aws.github.io/chalice/>`__.

Quickstart
==========

.. quick-start-begin

In this tutorial, you'll use the ``chalice`` command line