summaryrefslogtreecommitdiff
path: root/python-knativekafka.spec
blob: e323b8d857fd1eabd312da7a723a26def7b25903 (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
415
416
417
418
419
420
421
%global _empty_manifest_terminate_build 0
Name:		python-knativekafka
Version:	0.4.0
Release:	1
Summary:	A wrapper for kafka-python used in knative
License:	Apache Software License
URL:		https://github.optum.com/Optum-Serverless/kafka-source/tree/master/python/knativekafka
Source0:	https://mirrors.aliyun.com/pypi/web/packages/e0/3f/3832f13009d6f89bf9af7f39108f3c0cf7e764e595c8542354d8aa4b4e2b/knativekafka-0.4.0.tar.gz
BuildArch:	noarch

Requires:	python3-kafka-python

%description
## knativekafka

knativekafka is a wrapper around kafka-python package. This package is easy to use and can be used to test the Kafka Producer in kafka-python package.

Some important items to note.

* This package includes the basic testing only as of now.

*  Polling, parallelism etc. has not been included yet.

### Installation Instructions

The package is availble in PyPI which is an official repository for python package.
pip is a package management system and is used for installing Python packages from Python Package Index (also known as PyPI). It is the most common way to install Python packages.
Install the package in your environment from the terminal using the below pip command:

`pip3 install knativekafka`


### Pre-requisites

- Python 3.x

- pip3

- Set the environment variable - KAFKA_BOOTSTRAP_SERVERS

- Have the kafka server installed and configured with a topic


### How to Use?

* Import the Kafka Producer into your python code using the below import.

`from knativekafka.knativekafkaproducer import KNativeKafkaProducer`

* To import the Kafka Consumer use the below import.
`from knativekafka.knativekafkaconsumer import KNativeKafkaConsumer`


#### Usage

* Only few features are implemented in the package as of now. 

* Additional features to be included later.

#### Test Producer

To test the producer, perform the below steps.

* Instantiate the KNativeKafkaProducer by passing the kafka topic.

* Bootstrap Servers -- The init() method checks whether the os.environ() contains the KAFKA_BOOTSTRAP_SERVERS key. 

* If so, it fetches the value from the environment. If not, it sets the default value as localhost:9092. 

* Topic -- The topic is passed as parameter. Since, topic is a required field,if topic is an empty string, then, topic is retrieved from the environment variable. If topic is not passed and environment variable doesn't contain KAFKA_TOPIC, ValueError is thrown. To send data, use the send_binary_data() by passing the message as parameter. The send_binary_data() takes the message in binary format.

* TLS Enabled -- If environment variable - KAFKA_NET_TLS_ENABLE is found and has value True, then, TLS is enabled.
Get the tls information such as ssl_cafile, ssl_certfile and ssl_keyfile from the corresponding environment variable. The environment variables are KAFKA_NET_TLS_CA_CERT,
KAFKA_NET_TLS_CERT and KAFKA_NET_TLS_KEY.

* TLS Disabled -- If either environment variable - KAFKA_NET_TLS_ENABLE is not found or has value False, then, TLS is disabled.
Set the value for the tls fields such as ssl_cafile, ssl_certfile and ssl_keyfile to None.

```
    topic = "python-topic"
    kafka_producer = KNativeKafkaProducer(topic=topic)
    value = input('value:')
    value = bytes(value, encoding='utf8')            
    kafka_producer.send_binary_data(value)    
    print("Successfully sent data....") 

```

#### Test Consumer

To test the consumer, perform the below steps.

* Instantiate the KNativeKafkaConsumer by passing the topic and then, call display_message(). The display_message() prints the message values.

* Bootstrap Servers -- The init() method checks whether the os.environ() contains the KAFKA_BOOTSTRAP_SERVERS key. 

* If so, it fetches the value from the environment. If not, it sets the default value as localhost:9092. 

* Topic -- The topic is passed as parameter. Since, topic is a required field,if topic is an empty string, then, topic is retrieved from the environment variable. If topic is not passed and environment variable doesn't contain KAFKA_TOPIC, ValueError is thrown. To send data, use the send_binary_data() by passing the message as parameter. The send_binary_data() takes the message in binary format.

* TLS Enabled -- If environment variable - KAFKA_NET_TLS_ENABLE is found and has value True, then, TLS is enabled.
Get the tls information such as ssl_cafile, ssl_certfile and ssl_keyfile from the corresponding environment variable. The environment variables are KAFKA_NET_TLS_CA_CERT,
KAFKA_NET_TLS_CERT and KAFKA_NET_TLS_KEY.

* TLS Disabled -- If either environment variable - KAFKA_NET_TLS_ENABLE is not found or has value False, then, TLS is disabled.
Set the value for the tls fields such as ssl_cafile, ssl_certfile and ssl_keyfile to None.

```
topic = "python-topic"
kafka_consumer =  KNativeKafkaConsumer(topics=topic)
kafka_consumer.display_message()    


```
#### References

- [knativekafka in test.pypi.org](https://test.pypi.org/project/knativekafka/0.4.0/)

- [knativekafka in pypi.org](https://pypi.org/project/knativekafka/0.4.0/)

### License

```
Apache License

```





%package -n python3-knativekafka
Summary:	A wrapper for kafka-python used in knative
Provides:	python-knativekafka
BuildRequires:	python3-devel
BuildRequires:	python3-setuptools
BuildRequires:	python3-pip
%description -n python3-knativekafka
## knativekafka

knativekafka is a wrapper around kafka-python package. This package is easy to use and can be used to test the Kafka Producer in kafka-python package.

Some important items to note.

* This package includes the basic testing only as of now.

*  Polling, parallelism etc. has not been included yet.

### Installation Instructions

The package is availble in PyPI which is an official repository for python package.
pip is a package management system and is used for installing Python packages from Python Package Index (also known as PyPI). It is the most common way to install Python packages.
Install the package in your environment from the terminal using the below pip command:

`pip3 install knativekafka`


### Pre-requisites

- Python 3.x

- pip3

- Set the environment variable - KAFKA_BOOTSTRAP_SERVERS

- Have the kafka server installed and configured with a topic


### How to Use?

* Import the Kafka Producer into your python code using the below import.

`from knativekafka.knativekafkaproducer import KNativeKafkaProducer`

* To import the Kafka Consumer use the below import.
`from knativekafka.knativekafkaconsumer import KNativeKafkaConsumer`


#### Usage

* Only few features are implemented in the package as of now. 

* Additional features to be included later.

#### Test Producer

To test the producer, perform the below steps.

* Instantiate the KNativeKafkaProducer by passing the kafka topic.

* Bootstrap Servers -- The init() method checks whether the os.environ() contains the KAFKA_BOOTSTRAP_SERVERS key. 

* If so, it fetches the value from the environment. If not, it sets the default value as localhost:9092. 

* Topic -- The topic is passed as parameter. Since, topic is a required field,if topic is an empty string, then, topic is retrieved from the environment variable. If topic is not passed and environment variable doesn't contain KAFKA_TOPIC, ValueError is thrown. To send data, use the send_binary_data() by passing the message as parameter. The send_binary_data() takes the message in binary format.

* TLS Enabled -- If environment variable - KAFKA_NET_TLS_ENABLE is found and has value True, then, TLS is enabled.
Get the tls information such as ssl_cafile, ssl_certfile and ssl_keyfile from the corresponding environment variable. The environment variables are KAFKA_NET_TLS_CA_CERT,
KAFKA_NET_TLS_CERT and KAFKA_NET_TLS_KEY.

* TLS Disabled -- If either environment variable - KAFKA_NET_TLS_ENABLE is not found or has value False, then, TLS is disabled.
Set the value for the tls fields such as ssl_cafile, ssl_certfile and ssl_keyfile to None.

```
    topic = "python-topic"
    kafka_producer = KNativeKafkaProducer(topic=topic)
    value = input('value:')
    value = bytes(value, encoding='utf8')            
    kafka_producer.send_binary_data(value)    
    print("Successfully sent data....") 

```

#### Test Consumer

To test the consumer, perform the below steps.

* Instantiate the KNativeKafkaConsumer by passing the topic and then, call display_message(). The display_message() prints the message values.

* Bootstrap Servers -- The init() method checks whether the os.environ() contains the KAFKA_BOOTSTRAP_SERVERS key. 

* If so, it fetches the value from the environment. If not, it sets the default value as localhost:9092. 

* Topic -- The topic is passed as parameter. Since, topic is a required field,if topic is an empty string, then, topic is retrieved from the environment variable. If topic is not passed and environment variable doesn't contain KAFKA_TOPIC, ValueError is thrown. To send data, use the send_binary_data() by passing the message as parameter. The send_binary_data() takes the message in binary format.

* TLS Enabled -- If environment variable - KAFKA_NET_TLS_ENABLE is found and has value True, then, TLS is enabled.
Get the tls information such as ssl_cafile, ssl_certfile and ssl_keyfile from the corresponding environment variable. The environment variables are KAFKA_NET_TLS_CA_CERT,
KAFKA_NET_TLS_CERT and KAFKA_NET_TLS_KEY.

* TLS Disabled -- If either environment variable - KAFKA_NET_TLS_ENABLE is not found or has value False, then, TLS is disabled.
Set the value for the tls fields such as ssl_cafile, ssl_certfile and ssl_keyfile to None.

```
topic = "python-topic"
kafka_consumer =  KNativeKafkaConsumer(topics=topic)
kafka_consumer.display_message()    


```
#### References

- [knativekafka in test.pypi.org](https://test.pypi.org/project/knativekafka/0.4.0/)

- [knativekafka in pypi.org](https://pypi.org/project/knativekafka/0.4.0/)

### License

```
Apache License

```





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

knativekafka is a wrapper around kafka-python package. This package is easy to use and can be used to test the Kafka Producer in kafka-python package.

Some important items to note.

* This package includes the basic testing only as of now.

*  Polling, parallelism etc. has not been included yet.

### Installation Instructions

The package is availble in PyPI which is an official repository for python package.
pip is a package management system and is used for installing Python packages from Python Package Index (also known as PyPI). It is the most common way to install Python packages.
Install the package in your environment from the terminal using the below pip command:

`pip3 install knativekafka`


### Pre-requisites

- Python 3.x

- pip3

- Set the environment variable - KAFKA_BOOTSTRAP_SERVERS

- Have the kafka server installed and configured with a topic


### How to Use?

* Import the Kafka Producer into your python code using the below import.

`from knativekafka.knativekafkaproducer import KNativeKafkaProducer`

* To import the Kafka Consumer use the below import.
`from knativekafka.knativekafkaconsumer import KNativeKafkaConsumer`


#### Usage

* Only few features are implemented in the package as of now. 

* Additional features to be included later.

#### Test Producer

To test the producer, perform the below steps.

* Instantiate the KNativeKafkaProducer by passing the kafka topic.

* Bootstrap Servers -- The init() method checks whether the os.environ() contains the KAFKA_BOOTSTRAP_SERVERS key. 

* If so, it fetches the value from the environment. If not, it sets the default value as localhost:9092. 

* Topic -- The topic is passed as parameter. Since, topic is a required field,if topic is an empty string, then, topic is retrieved from the environment variable. If topic is not passed and environment variable doesn't contain KAFKA_TOPIC, ValueError is thrown. To send data, use the send_binary_data() by passing the message as parameter. The send_binary_data() takes the message in binary format.

* TLS Enabled -- If environment variable - KAFKA_NET_TLS_ENABLE is found and has value True, then, TLS is enabled.
Get the tls information such as ssl_cafile, ssl_certfile and ssl_keyfile from the corresponding environment variable. The environment variables are KAFKA_NET_TLS_CA_CERT,
KAFKA_NET_TLS_CERT and KAFKA_NET_TLS_KEY.

* TLS Disabled -- If either environment variable - KAFKA_NET_TLS_ENABLE is not found or has value False, then, TLS is disabled.
Set the value for the tls fields such as ssl_cafile, ssl_certfile and ssl_keyfile to None.

```
    topic = "python-topic"
    kafka_producer = KNativeKafkaProducer(topic=topic)
    value = input('value:')
    value = bytes(value, encoding='utf8')            
    kafka_producer.send_binary_data(value)    
    print("Successfully sent data....") 

```

#### Test Consumer

To test the consumer, perform the below steps.

* Instantiate the KNativeKafkaConsumer by passing the topic and then, call display_message(). The display_message() prints the message values.

* Bootstrap Servers -- The init() method checks whether the os.environ() contains the KAFKA_BOOTSTRAP_SERVERS key. 

* If so, it fetches the value from the environment. If not, it sets the default value as localhost:9092. 

* Topic -- The topic is passed as parameter. Since, topic is a required field,if topic is an empty string, then, topic is retrieved from the environment variable. If topic is not passed and environment variable doesn't contain KAFKA_TOPIC, ValueError is thrown. To send data, use the send_binary_data() by passing the message as parameter. The send_binary_data() takes the message in binary format.

* TLS Enabled -- If environment variable - KAFKA_NET_TLS_ENABLE is found and has value True, then, TLS is enabled.
Get the tls information such as ssl_cafile, ssl_certfile and ssl_keyfile from the corresponding environment variable. The environment variables are KAFKA_NET_TLS_CA_CERT,
KAFKA_NET_TLS_CERT and KAFKA_NET_TLS_KEY.

* TLS Disabled -- If either environment variable - KAFKA_NET_TLS_ENABLE is not found or has value False, then, TLS is disabled.
Set the value for the tls fields such as ssl_cafile, ssl_certfile and ssl_keyfile to None.

```
topic = "python-topic"
kafka_consumer =  KNativeKafkaConsumer(topics=topic)
kafka_consumer.display_message()    


```
#### References

- [knativekafka in test.pypi.org](https://test.pypi.org/project/knativekafka/0.4.0/)

- [knativekafka in pypi.org](https://pypi.org/project/knativekafka/0.4.0/)

### License

```
Apache License

```





%prep
%autosetup -n knativekafka-0.4.0

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

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

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