معرفی شرکت ها
faastapi-0.3.4
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشترتوضیحات
Easily create OpenFaas functions built on top of FastAPI Python framework
| ویژگی | مقدار |
|---|---|
| سیستم عامل | - |
| نام فایل | faastapi-0.3.4 |
| نام | faastapi |
| نسخه کتابخانه | 0.3.4 |
| نگهدارنده | ['Carlos Benavides'] |
| ایمیل نگهدارنده | ['carlos.benavides@capgemini.com'] |
| نویسنده | Carlos Benavides |
| ایمیل نویسنده | carlos.benavides@capgemini.com |
| آدرس صفحه اصلی | https://monsoon-gitlab.iti.gr/cap-dev/faastapi |
| آدرس اینترنتی | https://pypi.org/project/faastapi/ |
| مجوز | MIT |
# FaastAPI
> Easily create OpenFaas functions built on top of FastAPI Python framework
### Warning:
This project is in its early phase. It might be subject to a lot of changes and many features might be added/removed.
## Overview
`FaastAPI` is built on top of [FastAPI](https://pypi.org/project/fastapi/) framework, [pydantic](https://pypi.org/project/pydantic/) library, and [jinja2](https://pypi.org/project/Jinja2/) library.
It allows developers to quickly generate [OpenFaas](https://www.openfaas.com/) functions.
Several plugins can be used to quicly set up a rest API. A command line interface can be installed with the package so that functions can be tested locally.
## Installation
You can install package using pip:
```shell
pip install faastapi
```
By default, the command line interface and plugins are not installed. You can choose to install the cli using the `cli` extra:
```shell
pip install faastapi[cli]
```
## Example
A simple Faastapi function file (by default Faastapi search files named `faastapi.yml`) can be as follow:
```yaml
---
apiversion: v1
meta:
name: hello-faastapi
version: 0.3.4
image: gcharbon/hello-fastapi
tags:
- test
- demo
description: A dummy function to demonstrate Faastapi
build:
plugins:
basic-auth:
username: admin
password: password
mongodb:
host: 127.0.0.1
port: 27017
database: demo
sqlite:
uri: sqlite:///example.db
async-sqlite:
instrumentation:
run:
script: hello.py
function: say_hello
method: post
input:
name:
type: str
default: World
output:
message: str
date: datetime
drivers: Dict[str,str]
```
Considering the file `hello.py` is present next to `faastapi.yml` with the following content:
```python
import datetime
def say_hello(context, name):
return {
"message": f"Hello {name}",
"date": datetime.datetime.now(),
"drivers": {
"mongodb": str(context.mongodb),
"sqlite": str(context.sql),
"async-sqlite": str(context.async_sql),
},
}
```
> Note: As you can see function must always accept an argument named `context`. In this case, since `sqlite`, `async-sqlite` and `mongodb` plugins where specified, clients are available in the context.
When the user run `faastapi function new -f faastapi.yml openfaas`, an OpenFaas function will be generated in the `openfaas` directory.
This function can then be deployed to OpenFaas with `faas-cli`:
```shell
cd openfaas/
faas-cli up -f function.yml
```
You can then try the function on OpenFaas portal (`http://<OPENFAAS_URL>`):
You can also access the documentation of the function at `http://<OPENFAAS_URL>/function/hello-faastapi/docs`:
## List of available plugins
#### Security plugins:
- `basic-auth`: Enables a basic authentication in your application.
> Note: Username and password can be configured as in the above example
- `oauth2-password`: Enable simple oauth2 with password and bearer.
> Note: At this moment, configuration of user database is not possible, thus usage is limited to default values (username: `admin`, password: `secret`)
#### Databases plugins:
- `sqlite`: Injects an [sqlalchemy](https://www.sqlalchemy.org/) `Session` with `sqlite3` engine into the context by default.
- `postgres`: Injects an sqlachemy `Session` with `psycopg2` engine into the context by default.
- `mysql`: Injects an sqlalchemy `Session` with `mysqlclient` engine into the context by default.
- `async-sqlite`: Injects a `databases.Database` instance with `aiosqlite` engine into the context by default.
- `async-postgres`: Injects a `databases.Database` instance with `asyncpg` engine into the context by default.
- `async-mysql`: Injects a `databases.Database` instance with `aiomysql` engine into the context by default.
> Note: All those plugins accept a single configuration variable: `uri`
- `mongodb`: Injects a `pymongo.Database` instance into the context.
> Note: MongoDB plugin can be configured using the variables: `host` (default to `127.0.0.1`), `port` (default to `27017`) and `database` (default to `test`)
- `redis`: Injects a `Redis` instance into the context.
> Note: Redis plugin can be configured using the variables: `host` (default to `127.0.0.1`), `port` (default to `6379`) and `db` (default to `0`)
نیازمندی
| مقدار | نام |
|---|---|
| >=0.33.0,<0.34.0 | fastapi |
| >=0.8.6,<0.9.0 | uvicorn |
| >=7.0,<8.0) | click |
| >=5.1,<6.0) | pyyaml |
| >=2.10,<3.0) | jinja2 |
| >=1.7,<2.0) | PyJWT |
| >=1.7,<2.0) | passlib |
| >=0.0.5,<0.0.6) | python-multipart |
| >=3.1,<4.0) | bcrypt |
| >=1.3,<2.0) | sqlalchemy |
| >=1.4,<2.0) | mysqlclient |
| >=2.8,<3.0) | psycopg2 |
| >=0.2.5,<0.3.0) | databases |
| >=0.18.3,<0.19.0) | asyncpg |
| >=0.0.20,<0.0.21) | aiomysql |
| >=0.10.0,<0.11.0) | aiosqlite |
| >=3.8,<4.0) | pymongo |
| >=3.3,<4.0) | redis |
زبان مورد نیاز
| مقدار | نام |
|---|---|
| >=3.6,<4.0 | Python |
نحوه نصب
نصب پکیج whl faastapi-0.3.4:
pip install faastapi-0.3.4.whl
نصب پکیج tar.gz faastapi-0.3.4:
pip install faastapi-0.3.4.tar.gz