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
|
%global _empty_manifest_terminate_build 0
Name: python-research-data-services-common
Version: 0.53
Release: 1
Summary: The token and service implementation of sciebo RDS
License: MIT
URL: https://github.com/Sciebo-RDS/py-research-data-services-common
Source0: https://mirrors.aliyun.com/pypi/web/packages/04/e2/7cf3e1f98f79f268fe20a774be4a2ddd6e38e8833290dde182390b241881/research-data-services-common-0.53.tar.gz
BuildArch: noarch
Requires: python3-flask
%description
[](https://codeclimate.com/github/Sciebo-RDS/py-research-data-services-common/maintainability)[](https://codeclimate.com/github/Sciebo-RDS/py-research-data-services-common/test_coverage)[](https://badge.fury.io/py/research-data-services-common)
# Research Data Services Common Package
This package make the most common modules in Sciebo RDS available in one place, so we do not have to maintain them in several places.
In the RDS project, we use OAuth2 for authentication between numerious services, so we need a datastructure with methods, which supports this.
So this package implement 3 basic classes (User, Service, Token), which handles standard user-password authentication.
If you need this classes with oauth2-support, you have to use the corresponding version (e.g. Service => Oauth2Service). (Notice: User does not have an oauth2-version, because token takes care of password or token and service takes care of everything else for oauth2.)
## Usage
You can find some examples to use this package below. If you need more, please take a look into the tests or [sciebo RDS](https://github.com/Sciebo-RDS/Sciebo-RDS) (e.g. [Token Storage](https://github.com/Sciebo-RDS/Sciebo-RDS/blob/master/RDS/circle3_central_services/token_storage/src/lib/Storage.py)).
```python
from RDS import User
user1 = User("Max Mustermann")
```
## Installation
```bash
pip install research-data-services-common
```
### Optional dependencies
If you want to work with flask, you can use some additional features, when it is installed.
```bash
pip install "research-data-services-common[flask]"
```
## JSONEncoder
With flask installed, you can use the JSONEncoder for flask.
```python
from flask import Flask, jsonify
from RDS import Util
app = Flask(__name__)
app.json_encoder = Util.get_encoder(func_name="to_dict")
class Storage():
def to_dict(self):
return {"foo": "bar"}
@app.route("/")
def hello():
return jsonify(Storage())
```
If you want to use builtin json, you do not need flask. Then you can use *monkeypatch*-method.
```python
from RDS import Util
import json
class Storage():
def to_dict(self):
return {"foo": "bar"}
Util.monkeypatch(func_name="to_dict")
print(json.dumps(Storage())) # expects: '{"foo":"bar"}'
```
**Notice**: func_name defaults to *to_json*.
### Monkeypatch JSONEncoder in Flask
If you want to monkeypatch json and flask, you can use the helper function *monkeypatch* from RDS.
```python
from RDS import Util
Util.monkeypatch()
```
If it runs in a flask app context, it patches the app by itself. Otherwise you have to set the *app*-argument.
```python
from flask import Flask
app = Flask(__name__)
@app.route('/')
def hello_world():
return 'Hello, World!'
from RDS import Util
Util.monkeypatch("getDict", app=app)
```
The first argument in the previous example, you can see how to set the method, which should be used for json encoding from your object. The *monkeypatch*-method patches JSONEncoder in your python installation and your app flask.
# RO-Crate Parser
This helps you to work with ro-crate-metadata files. Take a look in the [tests](https://github.com/Sciebo-RDS/py-research-data-services-common/blob/0a0e8bda0eaec1b539a5d5884feba4812b2d37db/tests/test_roparser.py#L19) to see, how this can be used.
## Available Modules
- User
- Service (Oauth2Service)
- Token (Oauth2Token)
- ROParser
%package -n python3-research-data-services-common
Summary: The token and service implementation of sciebo RDS
Provides: python-research-data-services-common
BuildRequires: python3-devel
BuildRequires: python3-setuptools
BuildRequires: python3-pip
%description -n python3-research-data-services-common
[](https://codeclimate.com/github/Sciebo-RDS/py-research-data-services-common/maintainability)[](https://codeclimate.com/github/Sciebo-RDS/py-research-data-services-common/test_coverage)[](https://badge.fury.io/py/research-data-services-common)
# Research Data Services Common Package
This package make the most common modules in Sciebo RDS available in one place, so we do not have to maintain them in several places.
In the RDS project, we use OAuth2 for authentication between numerious services, so we need a datastructure with methods, which supports this.
So this package implement 3 basic classes (User, Service, Token), which handles standard user-password authentication.
If you need this classes with oauth2-support, you have to use the corresponding version (e.g. Service => Oauth2Service). (Notice: User does not have an oauth2-version, because token takes care of password or token and service takes care of everything else for oauth2.)
## Usage
You can find some examples to use this package below. If you need more, please take a look into the tests or [sciebo RDS](https://github.com/Sciebo-RDS/Sciebo-RDS) (e.g. [Token Storage](https://github.com/Sciebo-RDS/Sciebo-RDS/blob/master/RDS/circle3_central_services/token_storage/src/lib/Storage.py)).
```python
from RDS import User
user1 = User("Max Mustermann")
```
## Installation
```bash
pip install research-data-services-common
```
### Optional dependencies
If you want to work with flask, you can use some additional features, when it is installed.
```bash
pip install "research-data-services-common[flask]"
```
## JSONEncoder
With flask installed, you can use the JSONEncoder for flask.
```python
from flask import Flask, jsonify
from RDS import Util
app = Flask(__name__)
app.json_encoder = Util.get_encoder(func_name="to_dict")
class Storage():
def to_dict(self):
return {"foo": "bar"}
@app.route("/")
def hello():
return jsonify(Storage())
```
If you want to use builtin json, you do not need flask. Then you can use *monkeypatch*-method.
```python
from RDS import Util
import json
class Storage():
def to_dict(self):
return {"foo": "bar"}
Util.monkeypatch(func_name="to_dict")
print(json.dumps(Storage())) # expects: '{"foo":"bar"}'
```
**Notice**: func_name defaults to *to_json*.
### Monkeypatch JSONEncoder in Flask
If you want to monkeypatch json and flask, you can use the helper function *monkeypatch* from RDS.
```python
from RDS import Util
Util.monkeypatch()
```
If it runs in a flask app context, it patches the app by itself. Otherwise you have to set the *app*-argument.
```python
from flask import Flask
app = Flask(__name__)
@app.route('/')
def hello_world():
return 'Hello, World!'
from RDS import Util
Util.monkeypatch("getDict", app=app)
```
The first argument in the previous example, you can see how to set the method, which should be used for json encoding from your object. The *monkeypatch*-method patches JSONEncoder in your python installation and your app flask.
# RO-Crate Parser
This helps you to work with ro-crate-metadata files. Take a look in the [tests](https://github.com/Sciebo-RDS/py-research-data-services-common/blob/0a0e8bda0eaec1b539a5d5884feba4812b2d37db/tests/test_roparser.py#L19) to see, how this can be used.
## Available Modules
- User
- Service (Oauth2Service)
- Token (Oauth2Token)
- ROParser
%package help
Summary: Development documents and examples for research-data-services-common
Provides: python3-research-data-services-common-doc
%description help
[](https://codeclimate.com/github/Sciebo-RDS/py-research-data-services-common/maintainability)[](https://codeclimate.com/github/Sciebo-RDS/py-research-data-services-common/test_coverage)[](https://badge.fury.io/py/research-data-services-common)
# Research Data Services Common Package
This package make the most common modules in Sciebo RDS available in one place, so we do not have to maintain them in several places.
In the RDS project, we use OAuth2 for authentication between numerious services, so we need a datastructure with methods, which supports this.
So this package implement 3 basic classes (User, Service, Token), which handles standard user-password authentication.
If you need this classes with oauth2-support, you have to use the corresponding version (e.g. Service => Oauth2Service). (Notice: User does not have an oauth2-version, because token takes care of password or token and service takes care of everything else for oauth2.)
## Usage
You can find some examples to use this package below. If you need more, please take a look into the tests or [sciebo RDS](https://github.com/Sciebo-RDS/Sciebo-RDS) (e.g. [Token Storage](https://github.com/Sciebo-RDS/Sciebo-RDS/blob/master/RDS/circle3_central_services/token_storage/src/lib/Storage.py)).
```python
from RDS import User
user1 = User("Max Mustermann")
```
## Installation
```bash
pip install research-data-services-common
```
### Optional dependencies
If you want to work with flask, you can use some additional features, when it is installed.
```bash
pip install "research-data-services-common[flask]"
```
## JSONEncoder
With flask installed, you can use the JSONEncoder for flask.
```python
from flask import Flask, jsonify
from RDS import Util
app = Flask(__name__)
app.json_encoder = Util.get_encoder(func_name="to_dict")
class Storage():
def to_dict(self):
return {"foo": "bar"}
@app.route("/")
def hello():
return jsonify(Storage())
```
If you want to use builtin json, you do not need flask. Then you can use *monkeypatch*-method.
```python
from RDS import Util
import json
class Storage():
def to_dict(self):
return {"foo": "bar"}
Util.monkeypatch(func_name="to_dict")
print(json.dumps(Storage())) # expects: '{"foo":"bar"}'
```
**Notice**: func_name defaults to *to_json*.
### Monkeypatch JSONEncoder in Flask
If you want to monkeypatch json and flask, you can use the helper function *monkeypatch* from RDS.
```python
from RDS import Util
Util.monkeypatch()
```
If it runs in a flask app context, it patches the app by itself. Otherwise you have to set the *app*-argument.
```python
from flask import Flask
app = Flask(__name__)
@app.route('/')
def hello_world():
return 'Hello, World!'
from RDS import Util
Util.monkeypatch("getDict", app=app)
```
The first argument in the previous example, you can see how to set the method, which should be used for json encoding from your object. The *monkeypatch*-method patches JSONEncoder in your python installation and your app flask.
# RO-Crate Parser
This helps you to work with ro-crate-metadata files. Take a look in the [tests](https://github.com/Sciebo-RDS/py-research-data-services-common/blob/0a0e8bda0eaec1b539a5d5884feba4812b2d37db/tests/test_roparser.py#L19) to see, how this can be used.
## Available Modules
- User
- Service (Oauth2Service)
- Token (Oauth2Token)
- ROParser
%prep
%autosetup -n research-data-services-common-0.53
%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-research-data-services-common -f filelist.lst
%dir %{python3_sitelib}/*
%files help -f doclist.lst
%{_docdir}/*
%changelog
* Fri Jun 09 2023 Python_Bot <Python_Bot@openeuler.org> - 0.53-1
- Package Spec generated
|
