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

.. image:: https://badges.gitter.im/awslabs/chalice.svg :target: https://gitter.im/awslabs/chalice?utm_source=badge&utm_medium=badge :alt: Gitter .. image:: https://readthedocs.org/projects/chalice/badge/?version=latest :target: http://aws.github.io/chalice/?badge=latest :alt: 文档状态

.. image:: https://aws.github.io/chalice/_images/chalice-logo-whitespace.png :target: https://aws.github.io/chalice/ :alt: Chalice徽标

Chalice是一个用于编写无服务器Python应用程序的框架。它允许你快速创建和部署使用AWS Lambda的应用程序。它提供：

• 一个用于创建、部署和管理应用程序的命令行工具
• 一个基于装饰器的API，用于集成Amazon API Gateway、Amazon S3、Amazon SNS、Amazon SQS和其他AWS服务
• 自动IAM策略生成

你可以创建REST API：

.. code-block:: python

from chalice import Chalice

app = Chalice(app_name="helloworld")

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

定期运行的任务：

.. code-block:: python

from chalice import Chalice, Rate

app = Chalice(app_name="helloworld")

# 每5分钟自动运行一次
@app.schedule(Rate(5, unit=Rate.MINUTES))
def periodic_task(event):
    return {"hello": "world"}

你可以将Lambda函数连接到S3事件：

.. code-block:: python

from chalice import Chalice

app = Chalice(app_name="helloworld")

# 每当有对象上传到'mybucket'时
# 这个Lambda函数就会被调用

@app.on_s3_event(bucket='mybucket')
def handler(event):
    print("对象上传到存储桶: %s，键: %s"
          % (event.bucket, event.key))

以及SQS队列：

.. code-block:: python

from chalice import Chalice

app = Chalice(app_name="helloworld")

# 每当有消息发送到"my-queue-name" SQS队列时
# 调用这个Lambda函数

@app.on_sqs_message(queue='my-queue-name')
def handler(event):
    for record in event:
        print("消息内容: %s" % record.body)

以及其他几个AWS资源。

一旦你编写完代码，只需运行chalice deploy，Chalice就会负责部署你的应用程序。

::

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

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

30秒内即可启动并运行。 尝试这个项目，并在Github上与我们分享你的反馈。

文档可在 这里 <http://aws.github.io/chalice/>__获取。

快速入门

.. quick-start-begin

在本教程中，你将使用chalice命令行工具创建和部署一个基本的REST API。本快速入门使用Python 3.7，但AWS Chalice支持AWS Lambda支持的所有Python版本，包括Python 3.7到Python 3.12。

你可以在Python下载页面 <https://www.python.org/downloads/>_找到最新的Python版本。

要安装Chalice，我们首先在Python 3.7中创建并激活一个虚拟环境::

$ python3 --version
Python 3.7.3
$ python3 -m venv venv37
$ . venv37/bin/activate

接下来我们使用pip安装Chalice::

$ python3 -m pip install chalice

你可以通过运行以下命令验证是否已安装Chalice::

$ chalice --help
Usage: chalice [OPTIONS] COMMAND [ARGS]...
...

凭证

在部署应用程序之前，请确保你已配置凭证。如果你之前已经配置过机器以运行boto3（适用于Python的AWS SDK）或AWS CLI，则可以跳过此部分。

如果这是你第一次为AWS配置凭证，可以按照以下步骤快速开始::

$ mkdir ~/.aws
$ cat >> ~/.aws/config
[default]
aws_access_key_id=YOUR_ACCESS_KEY_HERE
aws_secret_access_key=YOUR_SECRET_ACCESS_KEY
region=YOUR_REGION (例如 us-west-2, us-west-1 等)

如果你想了解有关所有支持的凭证配置方法的更多信息，请参阅 boto3文档 <http://boto3.readthedocs.io/en/latest/guide/configuration.html>__。

创建你的项目

接下来，我们将使用chalice命令创建一个新项目::

$ chalice new-project helloworld

这将创建一个helloworld目录。进入该目录。你会看到已经为你创建了几个文件::

$ cd helloworld
$ ls -la
drwxr-xr-x   .chalice
-rw-r--r--   app.py
-rw-r--r--   requirements.txt

现在你可以忽略.chalice目录，我们主要关注的两个文件是app.py和requirements.txt。

让我们看看app.py文件：

.. code-block:: python

from chalice import Chalice

app = Chalice(app_name='helloworld')


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

new-project命令创建了一个示例应用，定义了一个单一视图/，当调用时将返回JSON主体{"hello": "world"}。

部署

让我们部署这个应用。确保你在helloworld目录中，然后运行chalice deploy::

$ chalice deploy
Creating deployment package.
Creating IAM role: helloworld-dev
Creating lambda function: helloworld-dev
Creating Rest API
Resources deployed:
  - Lambda ARN: arn:aws:lambda:us-west-2:12345:function:helloworld-dev
  - Rest API URL: https://abcd.execute-api.us-west-2.amazonaws.com/api/

现在你已经使用API Gateway和Lambda启动并运行了一个API::

$ curl https://qxea58oupc.execute-api.us-west-2.amazonaws.com/api/
{"hello": "world"}

尝试对index()函数返回的字典进行修改。然后你可以通过运行chalice deploy重新部署你的更改。

.. quick-start-end

后续步骤

你现在已经使用chalice创建了第一个应用。你可以对app.py文件进行修改，然后重新运行chalice deploy来重新部署你的更改。

此时，你可以采取以下几个后续步骤：

• 教程 <https://aws.github.io/chalice/tutorials/index.html>__
  • 从几个引导教程中选择，这些教程将为你提供Chalice各种功能的分步示例。
• 主题 <https://aws.github.io/chalice/topics/index.html>__ - 深入了解Chalice特定领域的文档。 这里包含比教程更详细的文档。
• API参考 <https://aws.github.io/chalice/api.html>__ - Chalice公共API的所有类和方法的低级参考文档。

如果你已经完成了对Chalice的实验，想要清理，你可以使用chalice delete命令，Chalice将删除在运行chalice deploy命令时创建的所有资源。

::

$ chalice delete
Deleting Rest API: abcd4kwyl4
Deleting function aws:arn:lambda:region:123456789:helloworld-dev
Deleting IAM Role helloworld-dev

反馈

我们也很乐意听到你的声音。如果你有任何额外功能的想法，请在https://github.com/aws/chalice/issues创建Github问题。你也可以在gitter上与我们聊天：https://gitter.im/awslabs/chalice