summaryrefslogtreecommitdiff
path: root/python-django-post_office.spec
blob: 26baca917174a10057624bc766af895c7bb52fa0 (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
%global _empty_manifest_terminate_build 0
Name:		python-django-post-office
Version:	3.6.3
Release:	1
Summary:	A Django app to monitor and send mail asynchronously, complete with template support.
License:	MIT
URL:		https://github.com/ui/django-post_office
Source0:	https://mirrors.nju.edu.cn/pypi/web/packages/79/c2/c4cd1058ff4f524ecbfea4f6f35b7708ec6c9ec545c7073f20c4afb7ba2e/django-post_office-3.6.3.tar.gz
BuildArch:	noarch

Requires:	python3-bleach[css]
Requires:	python3-django
Requires:	python3-jsonfield
Requires:	python3-pytz
Requires:	python3-bleach
Requires:	python3-tox

%description
### Caching
if Django's caching mechanism is configured, `post_office` will cache
`EmailTemplate` instances . If for some reason you want to disable
caching, set `POST_OFFICE_CACHE` to `False` in `settings.py`:
```python
## All cache key will be prefixed by post_office:template:
## To turn OFF caching, you need to explicitly set POST_OFFICE_CACHE to False in settings
POST_OFFICE_CACHE = False
## Optional: to use a non default cache backend, add a "post_office" entry in CACHES
CACHES = {
    'post_office': {
        'BACKEND': 'django.core.cache.backends.memcached.PyLibMCCache',
        'LOCATION': '127.0.0.1:11211',
    }
}
```
### send_many()
`send_many()` is much more performant (generates less database queries)
when sending a large number of emails. `send_many()` is almost identical
to `mail.send()`, with the exception that it accepts a list of keyword
arguments that you'd usually pass into `mail.send()`:
```python
from post_office import mail
first_email = {
    'sender': 'from@example.com',
    'recipients': ['alice@example.com'],
    'subject': 'Hi!',
    'message': 'Hi Alice!'
}
second_email = {
    'sender': 'from@example.com',
    'recipients': ['bob@example.com'],
    'subject': 'Hi!',
    'message': 'Hi Bob!'
}
kwargs_list = [first_email, second_email]
mail.send_many(kwargs_list)
```
Attachments are not supported with `mail.send_many()`.
## Running Tests
To run the test suite:
```python
`which django-admin.py` test post_office --settings=post_office.test_settings --pythonpath=.
```
You can run the full test suite for all supported versions of Django and Python with:
```python
tox
```
or:
```python
python setup.py test
```
## Integration with Celery
If your Django project runs in a Celery enabled configuration, you can use its worker to send out
queued emails. Compared to the solution with cron (see above), or the solution with uWSGI timers
(see below) this setup has the big advantage that queued emails are send *immediately* after they
have been added to the mail queue. The delivery is still performed in a separate and asynchronous
task, which prevents sending emails during the request/response-cycle.
If you [configured Celery](https://docs.celeryproject.org/en/latest/userguide/application.html)
in your project and started the
[Celery worker](https://docs.celeryproject.org/en/latest/userguide/workers.html),
you should see something such as:

%package -n python3-django-post-office
Summary:	A Django app to monitor and send mail asynchronously, complete with template support.
Provides:	python-django-post-office
BuildRequires:	python3-devel
BuildRequires:	python3-setuptools
%description -n python3-django-post-office
### Caching
if Django's caching mechanism is configured, `post_office` will cache
`EmailTemplate` instances . If for some reason you want to disable
caching, set `POST_OFFICE_CACHE` to `False` in `settings.py`:
```python
## All cache key will be prefixed by post_office:template:
## To turn OFF caching, you need to explicitly set POST_OFFICE_CACHE to False in settings
POST_OFFICE_CACHE = False
## Optional: to use a non default cache backend, add a "post_office" entry in CACHES
CACHES = {
    'post_office': {
        'BACKEND': 'django.core.cache.backends.memcached.PyLibMCCache',
        'LOCATION': '127.0.0.1:11211',
    }
}
```
### send_many()
`send_many()` is much more performant (generates less database queries)
when sending a large number of emails. `send_many()` is almost identical
to `mail.send()`, with the exception that it accepts a list of keyword
arguments that you'd usually pass into `mail.send()`:
```python
from post_office import mail
first_email = {
    'sender': 'from@example.com',
    'recipients': ['alice@example.com'],
    'subject': 'Hi!',
    'message': 'Hi Alice!'
}
second_email = {
    'sender': 'from@example.com',
    'recipients': ['bob@example.com'],
    'subject': 'Hi!',
    'message': 'Hi Bob!'
}
kwargs_list = [first_email, second_email]
mail.send_many(kwargs_list)
```
Attachments are not supported with `mail.send_many()`.
## Running Tests
To run the test suite:
```python
`which django-admin.py` test post_office --settings=post_office.test_settings --pythonpath=.
```
You can run the full test suite for all supported versions of Django and Python with:
```python
tox
```
or:
```python
python setup.py test
```
## Integration with Celery
If your Django project runs in a Celery enabled configuration, you can use its worker to send out
queued emails. Compared to the solution with cron (see above), or the solution with uWSGI timers
(see below) this setup has the big advantage that queued emails are send *immediately* after they
have been added to the mail queue. The delivery is still performed in a separate and asynchronous
task, which prevents sending emails during the request/response-cycle.
If you [configured Celery](https://docs.celeryproject.org/en/latest/userguide/application.html)
in your project and started the
[Celery worker](https://docs.celeryproject.org/en/latest/userguide/workers.html),
you should see something such as:

%package help
Summary:	Development documents and examples for django-post-office
Provides:	python3-django-post-office-doc
%description help
### Caching
if Django's caching mechanism is configured, `post_office` will cache
`EmailTemplate` instances . If for some reason you want to disable
caching, set `POST_OFFICE_CACHE` to `False` in `settings.py`:
```python
## All cache key will be prefixed by post_office:template:
## To turn OFF caching, you need to explicitly set POST_OFFICE_CACHE to False in settings
POST_OFFICE_CACHE = False
## Optional: to use a non default cache backend, add a "post_office" entry in CACHES
CACHES = {
    'post_office': {
        'BACKEND': 'django.core.cache.backends.memcached.PyLibMCCache',
        'LOCATION': '127.0.0.1:11211',
    }
}
```
### send_many()
`send_many()` is much more performant (generates less database queries)
when sending a large number of emails. `send_many()` is almost identical
to `mail.send()`, with the exception that it accepts a list of keyword
arguments that you'd usually pass into `mail.send()`:
```python
from post_office import mail
first_email = {
    'sender': 'from@example.com',
    'recipients': ['alice@example.com'],
    'subject': 'Hi!',
    'message': 'Hi Alice!'
}
second_email = {
    'sender': 'from@example.com',
    'recipients': ['bob@example.com'],
    'subject': 'Hi!',
    'message': 'Hi Bob!'
}
kwargs_list = [first_email, second_email]
mail.send_many(kwargs_list)
```
Attachments are not supported with `mail.send_many()`.
## Running Tests
To run the test suite:
```python
`which django-admin.py` test post_office --settings=post_office.test_settings --pythonpath=.
```
You can run the full test suite for all supported versions of Django and Python with:
```python
tox
```
or:
```python
python setup.py test
```
## Integration with Celery
If your Django project runs in a Celery enabled configuration, you can use its worker to send out
queued emails. Compared to the solution with cron (see above), or the solution with uWSGI timers
(see below) this setup has the big advantage that queued emails are send *immediately* after they
have been added to the mail queue. The delivery is still performed in a separate and asynchronous
task, which prevents sending emails during the request/response-cycle.
If you [configured Celery](https://docs.celeryproject.org/en/latest/userguide/application.html)
in your project and started the
[Celery worker](https://docs.celeryproject.org/en/latest/userguide/workers.html),
you should see something such as:

%prep
%autosetup -n django-post-office-3.6.3

%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-post-office -f filelist.lst
%dir %{python3_sitelib}/*

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

%changelog
* Fri Feb 24 2023 Python_Bot <Python_Bot@openeuler.org> - 3.6.3-1
- Package Spec generated