# @tencent-serverless/tencent-flask

> Tencent Cloud Flask Serverless Component

Latest version **0.1.1-alpha.0** (published 2019-12-17) · Apache license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install @tencent-serverless/tencent-flask
pnpm add @tencent-serverless/tencent-flask
yarn add @tencent-serverless/tencent-flask
bun add @tencent-serverless/tencent-flask
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 0.1.1-alpha.0 |
| Published | 2019-12-17 |
| First published | 2019-12-17 |
| Weekly downloads | 0 |
| License | Apache |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 6 |
| Unpacked size | 38.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Tencent Cloud, Inc. |
| Maintainers | yugasun, anycodes |
| Keywords | flask, serverless, serverless-component, serverlesscomponent, tencent |

## Links

- npm: https://www.npmjs.com/package/@tencent-serverless/tencent-flask
- npm.io page: https://npm.io/package/@tencent-serverless/tencent-flask

## Dependencies (6)

- [ext](https://npm.io/package/ext.md) ^1.4.0
- [type](https://npm.io/package/type.md) ^2.0.0
- [@serverless/core](https://npm.io/package/@serverless/core.md) ^1.1.1
- [@serverless/tencent-scf](https://npm.io/package/@serverless/tencent-scf.md) ^2.0.1
- [@yugasun/python-requirements](https://npm.io/package/@yugasun/python-requirements.md) ^0.1.2
- [@serverless/tencent-apigateway](https://npm.io/package/@serverless/tencent-apigateway.md) ^2.0.0

## Recent versions

- 0.1.1-alpha.0 (latest) — 2019-12-17

## README

# 腾讯云 Flask Serverless Component

简体中文 | [English](./README.en.md)

## 简介

腾讯云 Flask Serverless Component, 支持 Restful API 服务的部署，不支持 Flask Command.

## 目录

0. [准备](#0-准备)
1. [安装](#1-安装)
2. [配置](#2-配置)
3. [部署](#3-部署)
4. [移除](#4-移除)


### 0. 准备

在使用此组件之前，需要将 `Flask` 和 `werkzeug` 添加到依赖文件 `requiements.txt` 中，比如：

```txt
Flask==1.0.2
werkzeug==0.16.0
```

### 1. 安装

通过 npm 全局安装 [serverless cli](https://github.com/serverless/serverless)

```shell
$ npm install -g serverless
```

### 2. 配置

本地创建 `serverless.yml` 文件，在其中进行如下配置

```shell
$ touch serverless.yml
```

```yml
# serverless.yml

MyComponent:
  component: "@serverless/tencent-flask"
  inputs:
    region: ap-guangzhou 
    functionName: flask-function
    code: ./
    functionConf:
      timeout: 10
      memorySize: 128
      environment:
        variables:
          TEST: vale
      vpcConfig:
        subnetId: ''
        vpcId: ''
    apigatewayConf:
      protocol: https
      environment: release
```

- [更多配置](./docs/configure.md)

### 3. 部署

如您的账号未 [登陆](https://cloud.tencent.com/login) 或 [注册](https://cloud.tencent.com/register) 腾讯云，您可以直接通过 `微信` 扫描命令行中的二维码进行授权登陆和注册。

通过 `sls` 命令进行部署，并可以添加 `--debug` 参数查看部署过程中的信息

```shell
$ sls --debug
```

### 4. 移除

通过以下命令移除部署的 API 网关

```shell
$ sls remove --debug
```

### 账号配置（可选）

当前默认支持 CLI 扫描二维码登录，如您希望配置持久的环境变量/秘钥信息，也可以本地创建 `.env` 文件

```shell
$ touch .env # 腾讯云的配置信息
```

在 `.env` 文件中配置腾讯云的 SecretId 和 SecretKey 信息并保存

如果没有腾讯云账号，可以在此 [注册新账号](https://cloud.tencent.com/register)。

如果已有腾讯云账号，可以在 [API 密钥管理](https://console.cloud.tencent.com/cam/capi) 中获取 `SecretId` 和`SecretKey`.

```text
# .env
TENCENT_SECRET_ID=123
TENCENT_SECRET_KEY=123
```

### 更多组件

可以在 [Serverless Components](https://github.com/serverless/components) repo 中查询更多组件的信息。

---
_Source: https://npm.io/package/@tencent-serverless/tencent-flask · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._