معرفی شرکت ها
fastapi-pagination-0.9.3
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشترتوضیحات
FastAPI pagination
| ویژگی | مقدار |
|---|---|
| سیستم عامل | - |
| نام فایل | fastapi-pagination-0.9.3 |
| نام | fastapi-pagination |
| نسخه کتابخانه | 0.9.3 |
| نگهدارنده | [] |
| ایمیل نگهدارنده | [] |
| نویسنده | Yurii Karabas |
| ایمیل نویسنده | 1998uriyyo@gmail.com |
| آدرس صفحه اصلی | https://github.com/uriyyo/fastapi-pagination |
| آدرس اینترنتی | https://pypi.org/project/fastapi-pagination/ |
| مجوز | MIT |
<h1 align="center">
<img alt="logo" src="https://raw.githubusercontent.com/uriyyo/fastapi-pagination/main/docs/img/logo.png">
</h1>
<div align="center">
<img alt="license" src="https://img.shields.io/badge/License-MIT-lightgrey">
<img alt="test" src="https://github.com/uriyyo/fastapi-pagination/workflows/Test/badge.svg">
<img alt="codecov" src="https://codecov.io/gh/uriyyo/fastapi-pagination/branch/main/graph/badge.svg?token=QqIqDQ7FZi">
<a href="https://pepy.tech/project/fastapi-pagination"><img alt="downloads" src="https://pepy.tech/badge/fastapi-pagination"></a>
<a href="https://pypi.org/project/fastapi-pagination"><img alt="pypi" src="https://img.shields.io/pypi/v/fastapi-pagination"></a>
<img alt="black" src="https://img.shields.io/badge/code%20style-black-000000.svg">
</div>
## Introduction
`fastapi-pagination` is a Python library designed to simplify pagination in FastAPI applications.
It provides a set of utility functions and data models to help you paginate your database queries
and return paginated responses to your clients.
With `fastapi-pagination`, you can easily define pagination parameters in your FastAPI endpoint functions,
and use them to generate paginated responses that include the requested subset of your data.
The library supports a variety of pagination strategies, including cursor-based pagination and page-based pagination.
`fastapi-pagination` is built on top of the popular `fastapi` library, and it works with a wide range
of SQL and NoSQL databases frameworks. It also supports async/await syntax and is compatible with Python 3.8 and higher.
Features:
* Simplifies pagination in FastAPI applications.
* Supports a variety of pagination strategies, including cursor-based pagination and page-based pagination
* Works with a wide range of SQL and NoSQL databases frameworks, including `SQLAlchemy`, `Tortoise ORM`, and `PyMongo`.
* Supports async/await syntax.
* Compatible with Python 3.8 and higher.
----
For more information on how to use fastapi-pagination, please refer to the
[official documentation](https://uriyyo-fastapi-pagination.netlify.app/).
---
## Installation
```bash
pip install fastapi-pagination
```
## Quickstart
All you need to do is to use `Page` class as a return type for your endpoint and call `paginate` function
on data you want to paginate.
```py
from fastapi import FastAPI
from pydantic import BaseModel, Field
# import all you need from fastapi-pagination
from fastapi_pagination import Page, add_pagination, paginate
app = FastAPI() # create FastAPI app
class UserOut(BaseModel): # define your model
name: str = Field(..., example="Steve")
surname: str = Field(..., example="Rogers")
users = [ # create some data
# ...
]
@app.get('/users', response_model=Page[UserOut]) # use Page[UserOut] as response model
async def get_users():
return paginate(users) # use paginate function to paginate your data
add_pagination(app) # important! add pagination to your app
```
Please, be careful when you work with databases, because default `paginate` will require to load all data in memory.
For instance, if you use `SQLAlchemy` you can use `paginate` from `fastapi_pagination.ext.sqlalchemy` module.
```py
from sqlalchemy import select
from fastapi_pagination.ext.sqlalchemy import paginate
@app.get('/users', response_model=Page[UserOut])
def get_users(db: Session = Depends(get_db)):
return paginate(db, select(User).order_by(User.created_at))
```
---
Code from `Quickstart` will generate OpenAPI schema as bellow:
<div align="center">
<img alt="app-example" src="https://raw.githubusercontent.com/uriyyo/fastapi-pagination/main/docs/img/example.png">
</div>
نیازمندی
| مقدار | نام |
|---|---|
| >=1.9.1 | pydantic |
| >=0.80.0 | fastapi |
| >=1.3.20 | SQLAlchemy |
| >=0.6.0 | databases |
| >=0.3.1 | orm |
| >=0.16.18,<0.20.0 | tortoise-orm |
| >=0.24.0 | asyncpg |
| >=0.11.2 | ormar |
| <5.0.0 | django |
| >=0.89,<0.110 | piccolo |
| >=2.5.1,<4.0.0 | motor |
| >=0.23.1,<0.28.0 | mongoengine |
| >=0.0.8,<0.0.9 | sqlmodel |
| >=0.7.16,<0.8.0 | pony |
| >=1.11.9,<2.0.0 | beanie |
| >=2.0.1680321678,<3.0.0 | sqlakeyset |
| >=3.25.6,<4.0.0 | scylla-driver |
زبان مورد نیاز
| مقدار | نام |
|---|---|
| >=3.8,<4.0 | Python |
نحوه نصب
نصب پکیج whl fastapi-pagination-0.9.3:
pip install fastapi-pagination-0.9.3.whl
نصب پکیج tar.gz fastapi-pagination-0.9.3:
pip install fastapi-pagination-0.9.3.tar.gz