summaryrefslogtreecommitdiff
path: root/python-cyclog.spec
blob: 3f7c47c2a267b7e85cd4583a34dde7fa2a575fcb (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
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
%global _empty_manifest_terminate_build 0
Name:		python-CycLog
Version:	1.1.4
Release:	1
Summary:	A python module to handle cyclic logs.
License:	The Unlicense (Unlicense)
URL:		https://github.com/jonatan1609/CycleLog
Source0:	https://mirrors.aliyun.com/pypi/web/packages/d0/8b/fc01ee2d22ff8885938d55681bc6d75dd35d4ac456d405cc8ad1e29fc027/CycLog-1.1.4.tar.gz
BuildArch:	noarch


%description
# CycleLog

This library will let you log into a cyclic file easily.

####  What is a cycle log?
- A cycle log is a log file which does not keep more than N lines, once the log reaches N lines the logger will delete older lines from the beginning,
so you can only have latest logs which you need to figure out the error, to reproduce last steps, and such.


### basic example:
```python
from CycLog import CycleLogger

logger = CycleLogger(
    file_name="your_project.log"
)
for i in range(10):
    logger.log(i)
```

which will be logged:

```
[27/01/2021 - 19:36] : 0
[27/01/2021 - 19:36] : 1
[27/01/2021 - 19:36] : 2
[27/01/2021 - 19:36] : 3
[27/01/2021 - 19:36] : 4
[27/01/2021 - 19:36] : 5
[27/01/2021 - 19:36] : 6
[27/01/2021 - 19:36] : 7
[27/01/2021 - 19:36] : 8
[27/01/2021 - 19:36] : 9

```

Since the default max lines is 500, we got the entire log. let's try to change it to 5:

```python
from CycLog import CycleLogger

logger = CycleLogger(
    file_name="your_project.log",
    max_lines=5
)
for i in range(10):
    logger.log(i)
```

And now we only get the last 5 lines.
```
[27/01/2021 - 19:38] : 5
[27/01/2021 - 19:38] : 6
[27/01/2021 - 19:38] : 7
[27/01/2021 - 19:38] : 8
[27/01/2021 - 19:38] : 9

```

In principle, you can give any object that has `__str__` method, `logger.log` 
converts implicitly any object to string.


### Few more settings:

> `include_date: bool`, default: `True`
>>determines whether to add time to log message or not.
> **it affects the format message only in case of the format message is the default.**
>>> for example, without date, a typical message will look:
>>>> `[19:38] : 9` 

> `include_time: bool`, default: `True`
>>determines whether to add date to log message or not.
> **it affects the format message only in case of the format message is the default.**
>>> for example, without time, a typical message will look:
>>>> `[27/01/2021] : 9`


>if both `include_time` and `include_date` will be False, a log will only show the message itself.
>> `logger.log("hello")` will log `hello`, without date or time.

> `max_lines: int`, default: `500`.
>>Determines the maximum of lines in a file.

>`message_format: str`, default: `"[{date} - {time}] : {message}"`
>> you can set it to your own message and then you 
can add keyword arguments to `logger.log`, for example:

 ```python
from CycLog import CycleLogger

logger = CycleLogger(
    file_name="your_project.log",
    max_lines=5,
    message_format=CycleLogger.MESSAGE_FORMAT + " [from {name} - {n}]"
)
for i in range(10):
    logger.log(i, name="Jonatan", n=i)
```
will be 
```[27/01/2021 - 19:50] : 5 [from Jonatan - 5]
[27/01/2021 - 19:50] : 6 [from Jonatan - 6]
[27/01/2021 - 19:50] : 7 [from Jonatan - 7]
[27/01/2021 - 19:50] : 8 [from Jonatan - 8]
[27/01/2021 - 19:50] : 9 [from Jonatan - 9]
```
>`date_format: str`, default: `"%d/%m/%Y"`
>> Determines how the date will look. 

>`time_format: str`, default: `"%H:%M"`
>> Determines how the time will look.

>`file_mode: str`, default: `a+`
>> A mode to open the file in, the mode must be writable and readable.
> you can see a list of modes and explanation: https://docs.python.org/3/library/functions.html#open

%package -n python3-CycLog
Summary:	A python module to handle cyclic logs.
Provides:	python-CycLog
BuildRequires:	python3-devel
BuildRequires:	python3-setuptools
BuildRequires:	python3-pip
%description -n python3-CycLog
# CycleLog

This library will let you log into a cyclic file easily.

####  What is a cycle log?
- A cycle log is a log file which does not keep more than N lines, once the log reaches N lines the logger will delete older lines from the beginning,
so you can only have latest logs which you need to figure out the error, to reproduce last steps, and such.


### basic example:
```python
from CycLog import CycleLogger

logger = CycleLogger(
    file_name="your_project.log"
)
for i in range(10):
    logger.log(i)
```

which will be logged:

```
[27/01/2021 - 19:36] : 0
[27/01/2021 - 19:36] : 1
[27/01/2021 - 19:36] : 2
[27/01/2021 - 19:36] : 3
[27/01/2021 - 19:36] : 4
[27/01/2021 - 19:36] : 5
[27/01/2021 - 19:36] : 6
[27/01/2021 - 19:36] : 7
[27/01/2021 - 19:36] : 8
[27/01/2021 - 19:36] : 9

```

Since the default max lines is 500, we got the entire log. let's try to change it to 5:

```python
from CycLog import CycleLogger

logger = CycleLogger(
    file_name="your_project.log",
    max_lines=5
)
for i in range(10):
    logger.log(i)
```

And now we only get the last 5 lines.
```
[27/01/2021 - 19:38] : 5
[27/01/2021 - 19:38] : 6
[27/01/2021 - 19:38] : 7
[27/01/2021 - 19:38] : 8
[27/01/2021 - 19:38] : 9

```

In principle, you can give any object that has `__str__` method, `logger.log` 
converts implicitly any object to string.


### Few more settings:

> `include_date: bool`, default: `True`
>>determines whether to add time to log message or not.
> **it affects the format message only in case of the format message is the default.**
>>> for example, without date, a typical message will look:
>>>> `[19:38] : 9` 

> `include_time: bool`, default: `True`
>>determines whether to add date to log message or not.
> **it affects the format message only in case of the format message is the default.**
>>> for example, without time, a typical message will look:
>>>> `[27/01/2021] : 9`


>if both `include_time` and `include_date` will be False, a log will only show the message itself.
>> `logger.log("hello")` will log `hello`, without date or time.

> `max_lines: int`, default: `500`.
>>Determines the maximum of lines in a file.

>`message_format: str`, default: `"[{date} - {time}] : {message}"`
>> you can set it to your own message and then you 
can add keyword arguments to `logger.log`, for example:

 ```python
from CycLog import CycleLogger

logger = CycleLogger(
    file_name="your_project.log",
    max_lines=5,
    message_format=CycleLogger.MESSAGE_FORMAT + " [from {name} - {n}]"
)
for i in range(10):
    logger.log(i, name="Jonatan", n=i)
```
will be 
```[27/01/2021 - 19:50] : 5 [from Jonatan - 5]
[27/01/2021 - 19:50] : 6 [from Jonatan - 6]
[27/01/2021 - 19:50] : 7 [from Jonatan - 7]
[27/01/2021 - 19:50] : 8 [from Jonatan - 8]
[27/01/2021 - 19:50] : 9 [from Jonatan - 9]
```
>`date_format: str`, default: `"%d/%m/%Y"`
>> Determines how the date will look. 

>`time_format: str`, default: `"%H:%M"`
>> Determines how the time will look.

>`file_mode: str`, default: `a+`
>> A mode to open the file in, the mode must be writable and readable.
> you can see a list of modes and explanation: https://docs.python.org/3/library/functions.html#open

%package help
Summary:	Development documents and examples for CycLog
Provides:	python3-CycLog-doc
%description help
# CycleLog

This library will let you log into a cyclic file easily.

####  What is a cycle log?
- A cycle log is a log file which does not keep more than N lines, once the log reaches N lines the logger will delete older lines from the beginning,
so you can only have latest logs which you need to figure out the error, to reproduce last steps, and such.


### basic example:
```python
from CycLog import CycleLogger

logger = CycleLogger(
    file_name="your_project.log"
)
for i in range(10):
    logger.log(i)
```

which will be logged:

```
[27/01/2021 - 19:36] : 0
[27/01/2021 - 19:36] : 1
[27/01/2021 - 19:36] : 2
[27/01/2021 - 19:36] : 3
[27/01/2021 - 19:36] : 4
[27/01/2021 - 19:36] : 5
[27/01/2021 - 19:36] : 6
[27/01/2021 - 19:36] : 7
[27/01/2021 - 19:36] : 8
[27/01/2021 - 19:36] : 9

```

Since the default max lines is 500, we got the entire log. let's try to change it to 5:

```python
from CycLog import CycleLogger

logger = CycleLogger(
    file_name="your_project.log",
    max_lines=5
)
for i in range(10):
    logger.log(i)
```

And now we only get the last 5 lines.
```
[27/01/2021 - 19:38] : 5
[27/01/2021 - 19:38] : 6
[27/01/2021 - 19:38] : 7
[27/01/2021 - 19:38] : 8
[27/01/2021 - 19:38] : 9

```

In principle, you can give any object that has `__str__` method, `logger.log` 
converts implicitly any object to string.


### Few more settings:

> `include_date: bool`, default: `True`
>>determines whether to add time to log message or not.
> **it affects the format message only in case of the format message is the default.**
>>> for example, without date, a typical message will look:
>>>> `[19:38] : 9` 

> `include_time: bool`, default: `True`
>>determines whether to add date to log message or not.
> **it affects the format message only in case of the format message is the default.**
>>> for example, without time, a typical message will look:
>>>> `[27/01/2021] : 9`


>if both `include_time` and `include_date` will be False, a log will only show the message itself.
>> `logger.log("hello")` will log `hello`, without date or time.

> `max_lines: int`, default: `500`.
>>Determines the maximum of lines in a file.

>`message_format: str`, default: `"[{date} - {time}] : {message}"`
>> you can set it to your own message and then you 
can add keyword arguments to `logger.log`, for example:

 ```python
from CycLog import CycleLogger

logger = CycleLogger(
    file_name="your_project.log",
    max_lines=5,
    message_format=CycleLogger.MESSAGE_FORMAT + " [from {name} - {n}]"
)
for i in range(10):
    logger.log(i, name="Jonatan", n=i)
```
will be 
```[27/01/2021 - 19:50] : 5 [from Jonatan - 5]
[27/01/2021 - 19:50] : 6 [from Jonatan - 6]
[27/01/2021 - 19:50] : 7 [from Jonatan - 7]
[27/01/2021 - 19:50] : 8 [from Jonatan - 8]
[27/01/2021 - 19:50] : 9 [from Jonatan - 9]
```
>`date_format: str`, default: `"%d/%m/%Y"`
>> Determines how the date will look. 

>`time_format: str`, default: `"%H:%M"`
>> Determines how the time will look.

>`file_mode: str`, default: `a+`
>> A mode to open the file in, the mode must be writable and readable.
> you can see a list of modes and explanation: https://docs.python.org/3/library/functions.html#open

%prep
%autosetup -n CycLog-1.1.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-CycLog -f filelist.lst
%dir %{python3_sitelib}/*

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

%changelog
* Tue Jun 20 2023 Python_Bot <Python_Bot@openeuler.org> - 1.1.4-1
- Package Spec generated