https://github.com/mtshaikh/flask-rest-paginate
Pagination Extension for flask-restful
https://github.com/mtshaikh/flask-rest-paginate
flask flask-restful flask-restplus pagination rest-api
Last synced: 8 months ago
JSON representation
Pagination Extension for flask-restful
- Host: GitHub
- URL: https://github.com/mtshaikh/flask-rest-paginate
- Owner: mtShaikh
- License: mit
- Created: 2019-10-23T07:32:13.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-10-04T10:24:28.000Z (over 2 years ago)
- Last Synced: 2025-09-05T04:06:56.915Z (9 months ago)
- Topics: flask, flask-restful, flask-restplus, pagination, rest-api
- Language: Python
- Size: 37.1 KB
- Stars: 18
- Watchers: 4
- Forks: 8
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Flask Rest Paginate
A Pagination Extension for Flask RESTful.
## Installation
Install the extension using
```
pip install flask-rest-paginate
```
## Usage
In your app, add the extension as follows
```py
from flask import Flask
from flask_restful import Api
from flask_sqlalchemy import SQLAlchemy
from flask_rest_paginate import Pagination
app = Flask(__name__)
app.config['SQLALCHEMY_DATABASE_URI'] = "sqlite:///paginate-test.db"
db = SQLAlchemy(app)
pagination = Pagination(app, db)
```
Use in your project as
```py
pagination.paginate(AuthorModel, author_schema)
```
You can also pass the `sqlalchemy` query object as
```py
pagination.paginate(AuthorModel.query.filter_by(id=author_id), author_schema)
```
If you want to use marshmallow schemas then set the third param `True`
```py
pagination.paginate(AuthorModel, marshamllow_author_schema, True)
```
## Customize your pagination schema
If you want create a custom pagination schema. You should pass pagination_schema_hook and return a Dict with you custom schema
```
res = pagination.paginate(
AuthorModel,
schema,
True,
pagination_schema_hook=lambda current_page, page_obj: {
"next": page_obj.has_next,
"prev": page_obj.has_prev,
"current": current_page,
"pages": page_obj.pages,
"per_page": page_obj.per_page,
"total": page_obj.total,
},
)
```
You can also customize key names where data and pagination info are placed, setting the configuration variables:
```
app.config['PAGINATE_PAGINATION_OBJECT_KEY'] = "page_info"
app.config['PAGINATE_DATA_OBJECT_KEY'] = "results"
...
{
"page_info": {
"currentPage": 1,
"hasNext": false,
"hasPrev": false,
"pages": 1,
"size": 20,
"totalElements": 2
}
"results": {
...
}
}
```
Furthermore, pagination info can be moved directly to the root of the result object:
```
app.config['PAGINATE_PAGINATION_OBJECT_KEY'] = None
app.config['PAGINATE_DATA_OBJECT_KEY'] = "results"
...
{
"currentPage": 1,
"hasNext": false,
"hasPrev": false,
"pages": 1,
"size": 20,
"totalElements": 2
"results": {
...
}
}
```
## Example:
Check the [example](https://github.com/mtShaikh/flask-rest-paginate/tree/master/example) folder for an example of the extension.
## Contributing
We are always grateful for any kind of contribution including but not limited to bug reports, code enhancements, bug fixes, and even functionality suggestions.
You can report any bug you find or suggest new functionality with a new [issue](https://github.com/mtShaikh/flask-rest-paginate/issues).
If you want to add yourself some functionality to the extension:
- Open an [issue](https://github.com/mtShaikh/flask-rest-paginate/issues)
- Comment there you are working on a new functionality
- Fork the [repo](https://github.com/mtShaikh/flask-rest-paginate/)
- Create your feature branch (git checkout -b my-new-feature)
- Commit your changes (git commit -am 'Adds my new feature')
- Push to the branch (git push origin my-new-feature)
- Create a new Pull Request
- mention the issue number in the PR description as `fixes #123, #321`