summaryrefslogtreecommitdiff
path: root/python-django-fast-paginator.spec
blob: ea1a9aaf8f848b970866adcd4b3c28810b5b9d0b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
%global _empty_manifest_terminate_build 0
Name:		python-django-fast-paginator
Version:	1.0.4
Release:	1
Summary:	A Django app to paginate querysets faster.
License:	MIT
URL:		https://github.com/bilbeyt/django-fast-pagination
Source0:	https://mirrors.aliyun.com/pypi/web/packages/e8/6e/1239568717b0a264e941b01bce4bdfcde3d369bd689e3fde4fdac4691801/django-fast-paginator-1.0.4.tar.gz
BuildArch:	noarch


%description
![Issues](https://img.shields.io/github/issues/bilbeyt/django-fast-pagination)
![Forks](https://img.shields.io/github/forks/bilbeyt/django-fast-pagination)
![Stars](https://img.shields.io/github/stars/bilbeyt/django-fast-pagination)
![License](https://img.shields.io/github/license/bilbeyt/django-fast-pagination)
![Twitter](https://img.shields.io/twitter/url?url=https%3A%2F%2Fgithub.com%2Fbilbeyt%2Fdjango-fast-pagination)


## Fast Paginator for Django
Simple speedy pagination over your large database tables.

## Features

**Simple Integration**

FastPaginator API is compatible with Django's built-in pagination library. Only change your import statements then you're ready.

**Better SQL Queries**

Django's built-in pagination system builds SQL queries that have offset and limit clauses. FastPagination does not use them.

**Built-in Cache System**

FastPaginator has a built-in cache system. It does not cache QuerySets but caches primary keys of object lists. This provides speedup for pagination progress.

## Quick Start

1. Add "fast_pagination" to your INSTALLED_APPS setting like this:
```python
    INSTALLED_APPS = [
        ... 
        'fast_pagination'
    ]
```
2. In Django settings, you can set FAST_PAGINATION_TIMEOUT variable to invalidate cache. Default value is 1 hour.
3. In Django settings, you can set FAST_PAGINATION_PREFIX variable to use in cache keys. Default values is 'fastpagination'.
4. Import FastPaginator like this:
```python
    from fast_pagination.helpers import FastPaginator
```
5. Then, you are ready. All you have to do is give your queryset and number of entries when creating FastPaginator object.

## To Run Tests

1. Create a dummy project.
2. Run following command.
```python
./manage.py test fast_pagination.tests
```

## Benchmark

This benchmark is executed on Postgres9.6 with a table that has 1000000 rows, and fetched only one field. Results can be seen below.

| Paginator     | Min              | Max              | Mean             | StdDev        | Median           |
|---------------|------------------|------------------|------------------|---------------|------------------|
| Django        | 93.5535 (1.53) | 95.7217 (1.54) | 94.7340 (1.53) | 0.9755 (2.32) | 94.9046 (1.54) |
| FastPaginator | 61.1488 (1.0)   | 62.3316 (1.0)    | 61.7489 (1.0)    | 0.4205 (1.0)  | 61.7649 (1.0)    |


You can also run benchmark tests following instructions:

1. Run migrations if app needs using
```bash
./manage.py migrate
```
2. Call generate_users command from command line using
```bash
./manage.py generate_users 1000000
```
3. Run tests using
```bash
pytest fast_pagination/tests.py
```

%package -n python3-django-fast-paginator
Summary:	A Django app to paginate querysets faster.
Provides:	python-django-fast-paginator
BuildRequires:	python3-devel
BuildRequires:	python3-setuptools
BuildRequires:	python3-pip
%description -n python3-django-fast-paginator
![Issues](https://img.shields.io/github/issues/bilbeyt/django-fast-pagination)
![Forks](https://img.shields.io/github/forks/bilbeyt/django-fast-pagination)
![Stars](https://img.shields.io/github/stars/bilbeyt/django-fast-pagination)
![License](https://img.shields.io/github/license/bilbeyt/django-fast-pagination)
![Twitter](https://img.shields.io/twitter/url?url=https%3A%2F%2Fgithub.com%2Fbilbeyt%2Fdjango-fast-pagination)


## Fast Paginator for Django
Simple speedy pagination over your large database tables.

## Features

**Simple Integration**

FastPaginator API is compatible with Django's built-in pagination library. Only change your import statements then you're ready.

**Better SQL Queries**

Django's built-in pagination system builds SQL queries that have offset and limit clauses. FastPagination does not use them.

**Built-in Cache System**

FastPaginator has a built-in cache system. It does not cache QuerySets but caches primary keys of object lists. This provides speedup for pagination progress.

## Quick Start

1. Add "fast_pagination" to your INSTALLED_APPS setting like this:
```python
    INSTALLED_APPS = [
        ... 
        'fast_pagination'
    ]
```
2. In Django settings, you can set FAST_PAGINATION_TIMEOUT variable to invalidate cache. Default value is 1 hour.
3. In Django settings, you can set FAST_PAGINATION_PREFIX variable to use in cache keys. Default values is 'fastpagination'.
4. Import FastPaginator like this:
```python
    from fast_pagination.helpers import FastPaginator
```
5. Then, you are ready. All you have to do is give your queryset and number of entries when creating FastPaginator object.

## To Run Tests

1. Create a dummy project.
2. Run following command.
```python
./manage.py test fast_pagination.tests
```

## Benchmark

This benchmark is executed on Postgres9.6 with a table that has 1000000 rows, and fetched only one field. Results can be seen below.

| Paginator     | Min              | Max              | Mean             | StdDev        | Median           |
|---------------|------------------|------------------|------------------|---------------|------------------|
| Django        | 93.5535 (1.53) | 95.7217 (1.54) | 94.7340 (1.53) | 0.9755 (2.32) | 94.9046 (1.54) |
| FastPaginator | 61.1488 (1.0)   | 62.3316 (1.0)    | 61.7489 (1.0)    | 0.4205 (1.0)  | 61.7649 (1.0)    |


You can also run benchmark tests following instructions:

1. Run migrations if app needs using
```bash
./manage.py migrate
```
2. Call generate_users command from command line using
```bash
./manage.py generate_users 1000000
```
3. Run tests using
```bash
pytest fast_pagination/tests.py
```

%package help
Summary:	Development documents and examples for django-fast-paginator
Provides:	python3-django-fast-paginator-doc
%description help
![Issues](https://img.shields.io/github/issues/bilbeyt/django-fast-pagination)
![Forks](https://img.shields.io/github/forks/bilbeyt/django-fast-pagination)
![Stars](https://img.shields.io/github/stars/bilbeyt/django-fast-pagination)
![License](https://img.shields.io/github/license/bilbeyt/django-fast-pagination)
![Twitter](https://img.shields.io/twitter/url?url=https%3A%2F%2Fgithub.com%2Fbilbeyt%2Fdjango-fast-pagination)


## Fast Paginator for Django
Simple speedy pagination over your large database tables.

## Features

**Simple Integration**

FastPaginator API is compatible with Django's built-in pagination library. Only change your import statements then you're ready.

**Better SQL Queries**

Django's built-in pagination system builds SQL queries that have offset and limit clauses. FastPagination does not use them.

**Built-in Cache System**

FastPaginator has a built-in cache system. It does not cache QuerySets but caches primary keys of object lists. This provides speedup for pagination progress.

## Quick Start

1. Add "fast_pagination" to your INSTALLED_APPS setting like this:
```python
    INSTALLED_APPS = [
        ... 
        'fast_pagination'
    ]
```
2. In Django settings, you can set FAST_PAGINATION_TIMEOUT variable to invalidate cache. Default value is 1 hour.
3. In Django settings, you can set FAST_PAGINATION_PREFIX variable to use in cache keys. Default values is 'fastpagination'.
4. Import FastPaginator like this:
```python
    from fast_pagination.helpers import FastPaginator
```
5. Then, you are ready. All you have to do is give your queryset and number of entries when creating FastPaginator object.

## To Run Tests

1. Create a dummy project.
2. Run following command.
```python
./manage.py test fast_pagination.tests
```

## Benchmark

This benchmark is executed on Postgres9.6 with a table that has 1000000 rows, and fetched only one field. Results can be seen below.

| Paginator     | Min              | Max              | Mean             | StdDev        | Median           |
|---------------|------------------|------------------|------------------|---------------|------------------|
| Django        | 93.5535 (1.53) | 95.7217 (1.54) | 94.7340 (1.53) | 0.9755 (2.32) | 94.9046 (1.54) |
| FastPaginator | 61.1488 (1.0)   | 62.3316 (1.0)    | 61.7489 (1.0)    | 0.4205 (1.0)  | 61.7649 (1.0)    |


You can also run benchmark tests following instructions:

1. Run migrations if app needs using
```bash
./manage.py migrate
```
2. Call generate_users command from command line using
```bash
./manage.py generate_users 1000000
```
3. Run tests using
```bash
pytest fast_pagination/tests.py
```

%prep
%autosetup -n django-fast-paginator-1.0.4

%build
%py3_build

%install
%py3_install
install -d -m755 %{buildroot}/%{_pkgdocdir}
if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi
if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi
if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi
if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi
pushd %{buildroot}
if [ -d usr/lib ]; then
	find usr/lib -type f -printf "\"/%h/%f\"\n" >> filelist.lst
fi
if [ -d usr/lib64 ]; then
	find usr/lib64 -type f -printf "\"/%h/%f\"\n" >> filelist.lst
fi
if [ -d usr/bin ]; then
	find usr/bin -type f -printf "\"/%h/%f\"\n" >> filelist.lst
fi
if [ -d usr/sbin ]; then
	find usr/sbin -type f -printf "\"/%h/%f\"\n" >> filelist.lst
fi
touch doclist.lst
if [ -d usr/share/man ]; then
	find usr/share/man -type f -printf "\"/%h/%f.gz\"\n" >> doclist.lst
fi
popd
mv %{buildroot}/filelist.lst .
mv %{buildroot}/doclist.lst .

%files -n python3-django-fast-paginator -f filelist.lst
%dir %{python3_sitelib}/*

%files help -f doclist.lst
%{_docdir}/*

%changelog
* Thu Jun 08 2023 Python_Bot <Python_Bot@openeuler.org> - 1.0.4-1
- Package Spec generated