Skip to content

Commit e578d50

Browse files
RKrahlRKrahl
committed
Update the tutorial: in particular instruct to read the example
content from icatdump-6.2.yaml instead of icatdump-5.0.yaml
1 parent 94ec4ee commit e578d50

8 files changed

Lines changed: 216 additions & 218 deletions

‎doc/src/tutorial-config-advanced.rst‎

Lines changed: 49 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ on the list of available command line options::
2727
[--no-proxy NO_PROXY] [-a AUTH] [-u USERNAME] [-P]
2828
[-p PASSWORD] [-o OUTFILE]
2929

30-
optional arguments:
30+
options:
3131
-h, --help show this help message and exit
3232
-c CONFIGFILE, --configfile CONFIGFILE
3333
config file
@@ -155,7 +155,7 @@ sub-commands should be listed::
155155
[-P] [-p PASSWORD] [-e {User,Study}]
156156
{list,create,delete} ...
157157

158-
optional arguments:
158+
options:
159159
-h, --help show this help message and exit
160160
-c CONFIGFILE, --configfile CONFIGFILE
161161
config file
@@ -194,10 +194,10 @@ config file (``-s SECTION``) as well as the `entity` variable (``-e
194194
listing existing User objects...
195195
[(user){
196196
createId = "simple/root"
197-
createTime = 2023-06-28 12:22:34+02:00
197+
createTime = 2025-12-01 15:32:07+01:00
198198
id = 1
199199
modId = "simple/root"
200-
modTime = 2023-06-28 12:22:34+02:00
200+
modTime = 2025-12-01 15:32:07+01:00
201201
affiliation = "University of Ravenna, Institute of Modern History"
202202
email = "acord@example.org"
203203
familyName = "Cordus"
@@ -207,10 +207,10 @@ config file (``-s SECTION``) as well as the `entity` variable (``-e
207207
orcidId = "0000-0002-3262"
208208
}, (user){
209209
createId = "simple/root"
210-
createTime = 2023-06-28 12:22:34+02:00
210+
createTime = 2025-12-01 15:32:07+01:00
211211
id = 2
212212
modId = "simple/root"
213-
modTime = 2023-06-28 12:22:34+02:00
213+
modTime = 2025-12-01 15:32:07+01:00
214214
affiliation = "Goethe University Frankfurt, Faculty of Philosophy and History"
215215
email = "ahau@example.org"
216216
familyName = "Hau"
@@ -220,10 +220,10 @@ config file (``-s SECTION``) as well as the `entity` variable (``-e
220220
orcidId = "0000-0002-3263"
221221
}, (user){
222222
createId = "simple/root"
223-
createTime = 2023-06-28 12:22:34+02:00
223+
createTime = 2025-12-01 15:32:07+01:00
224224
id = 3
225225
modId = "simple/root"
226-
modTime = 2023-06-28 12:22:34+02:00
226+
modTime = 2025-12-01 15:32:07+01:00
227227
affiliation = "Université Paul-Valéry Montpellier 3"
228228
email = "jbotu@example.org"
229229
familyName = "Botul"
@@ -233,21 +233,21 @@ config file (``-s SECTION``) as well as the `entity` variable (``-e
233233
orcidId = "0000-0002-3264"
234234
}, (user){
235235
createId = "simple/root"
236-
createTime = 2023-06-28 12:22:34+02:00
236+
createTime = 2025-12-01 15:32:07+01:00
237237
id = 4
238238
modId = "simple/root"
239-
modTime = 2023-06-28 12:22:34+02:00
239+
modTime = 2025-12-01 15:32:07+01:00
240240
email = "jdoe@example.org"
241241
familyName = "Doe"
242242
fullName = "John Doe"
243243
givenName = "John"
244244
name = "db/jdoe"
245245
}, (user){
246246
createId = "simple/root"
247-
createTime = 2023-06-28 12:22:34+02:00
247+
createTime = 2025-12-01 15:32:07+01:00
248248
id = 5
249249
modId = "simple/root"
250-
modTime = 2023-06-28 12:22:34+02:00
250+
modTime = 2025-12-01 15:32:07+01:00
251251
affiliation = "University of Nancago"
252252
email = "nbour@example.org"
253253
familyName = "Bourbaki"
@@ -257,10 +257,10 @@ config file (``-s SECTION``) as well as the `entity` variable (``-e
257257
orcidId = "0000-0002-3266"
258258
}, (user){
259259
createId = "simple/root"
260-
createTime = 2023-06-28 12:22:34+02:00
260+
createTime = 2025-12-01 15:32:07+01:00
261261
id = 6
262262
modId = "simple/root"
263-
modTime = 2023-06-28 12:22:34+02:00
263+
modTime = 2025-12-01 15:32:07+01:00
264264
affiliation = "Kaiser-Wilhelms-Akademie für das militärärztliche Bildungswesen"
265265
email = "rbeck@example.org"
266266
familyName = "Beck-Dülmen"
@@ -270,42 +270,42 @@ config file (``-s SECTION``) as well as the `entity` variable (``-e
270270
orcidId = "0000-0002-3267"
271271
}, (user){
272272
createId = "simple/root"
273-
createTime = 2023-06-28 12:22:34+02:00
273+
createTime = 2025-12-01 15:32:07+01:00
274274
id = 7
275275
modId = "simple/root"
276-
modTime = 2023-06-28 12:22:34+02:00
276+
modTime = 2025-12-01 15:32:07+01:00
277277
fullName = "Data Ingester"
278278
name = "simple/dataingest"
279279
}, (user){
280280
createId = "simple/root"
281-
createTime = 2023-06-28 12:22:34+02:00
281+
createTime = 2025-12-01 15:32:07+01:00
282282
id = 8
283283
modId = "simple/root"
284-
modTime = 2023-06-28 12:22:34+02:00
284+
modTime = 2025-12-01 15:32:07+01:00
285285
fullName = "IDS reader"
286286
name = "simple/idsreader"
287287
}, (user){
288288
createId = "simple/root"
289-
createTime = 2023-06-28 12:22:34+02:00
289+
createTime = 2025-12-01 15:32:07+01:00
290290
id = 9
291291
modId = "simple/root"
292-
modTime = 2023-06-28 12:22:34+02:00
292+
modTime = 2025-12-01 15:32:07+01:00
293293
fullName = "Pub reader"
294294
name = "simple/pubreader"
295295
}, (user){
296296
createId = "simple/root"
297-
createTime = 2023-06-28 12:22:34+02:00
297+
createTime = 2025-12-01 15:32:07+01:00
298298
id = 10
299299
modId = "simple/root"
300-
modTime = 2023-06-28 12:22:34+02:00
300+
modTime = 2025-12-01 15:32:07+01:00
301301
fullName = "Root"
302302
name = "simple/root"
303303
}, (user){
304304
createId = "simple/root"
305-
createTime = 2023-06-28 12:22:34+02:00
305+
createTime = 2025-12-01 15:32:07+01:00
306306
id = 11
307307
modId = "simple/root"
308-
modTime = 2023-06-28 12:22:34+02:00
308+
modTime = 2025-12-01 15:32:07+01:00
309309
fullName = "User Office"
310310
name = "simple/useroffice"
311311
}]
@@ -320,7 +320,7 @@ sub-command. We can check this by calling::
320320
$ python config-sub-commands.py create -h
321321
usage: config-sub-commands.py create [-h] [-n NAME]
322322

323-
optional arguments:
323+
options:
324324
-h, --help show this help message and exit
325325
-n NAME, --name NAME name for the new ICAT object
326326

@@ -340,10 +340,10 @@ with name "db/alice"::
340340
listing existing User objects...
341341
[(user){
342342
createId = "simple/root"
343-
createTime = 2023-06-28 12:22:34+02:00
343+
createTime = 2025-12-01 15:32:07+01:00
344344
id = 1
345345
modId = "simple/root"
346-
modTime = 2023-06-28 12:22:34+02:00
346+
modTime = 2025-12-01 15:32:07+01:00
347347
affiliation = "University of Ravenna, Institute of Modern History"
348348
email = "acord@example.org"
349349
familyName = "Cordus"
@@ -353,10 +353,10 @@ with name "db/alice"::
353353
orcidId = "0000-0002-3262"
354354
}, (user){
355355
createId = "simple/root"
356-
createTime = 2023-06-28 12:22:34+02:00
356+
createTime = 2025-12-01 15:32:07+01:00
357357
id = 2
358358
modId = "simple/root"
359-
modTime = 2023-06-28 12:22:34+02:00
359+
modTime = 2025-12-01 15:32:07+01:00
360360
affiliation = "Goethe University Frankfurt, Faculty of Philosophy and History"
361361
email = "ahau@example.org"
362362
familyName = "Hau"
@@ -366,10 +366,10 @@ with name "db/alice"::
366366
orcidId = "0000-0002-3263"
367367
}, (user){
368368
createId = "simple/root"
369-
createTime = 2023-06-28 12:22:34+02:00
369+
createTime = 2025-12-01 15:32:07+01:00
370370
id = 3
371371
modId = "simple/root"
372-
modTime = 2023-06-28 12:22:34+02:00
372+
modTime = 2025-12-01 15:32:07+01:00
373373
affiliation = "Université Paul-Valéry Montpellier 3"
374374
email = "jbotu@example.org"
375375
familyName = "Botul"
@@ -379,21 +379,21 @@ with name "db/alice"::
379379
orcidId = "0000-0002-3264"
380380
}, (user){
381381
createId = "simple/root"
382-
createTime = 2023-06-28 12:22:34+02:00
382+
createTime = 2025-12-01 15:32:07+01:00
383383
id = 4
384384
modId = "simple/root"
385-
modTime = 2023-06-28 12:22:34+02:00
385+
modTime = 2025-12-01 15:32:07+01:00
386386
email = "jdoe@example.org"
387387
familyName = "Doe"
388388
fullName = "John Doe"
389389
givenName = "John"
390390
name = "db/jdoe"
391391
}, (user){
392392
createId = "simple/root"
393-
createTime = 2023-06-28 12:22:34+02:00
393+
createTime = 2025-12-01 15:32:07+01:00
394394
id = 5
395395
modId = "simple/root"
396-
modTime = 2023-06-28 12:22:34+02:00
396+
modTime = 2025-12-01 15:32:07+01:00
397397
affiliation = "University of Nancago"
398398
email = "nbour@example.org"
399399
familyName = "Bourbaki"
@@ -403,10 +403,10 @@ with name "db/alice"::
403403
orcidId = "0000-0002-3266"
404404
}, (user){
405405
createId = "simple/root"
406-
createTime = 2023-06-28 12:22:34+02:00
406+
createTime = 2025-12-01 15:32:07+01:00
407407
id = 6
408408
modId = "simple/root"
409-
modTime = 2023-06-28 12:22:34+02:00
409+
modTime = 2025-12-01 15:32:07+01:00
410410
affiliation = "Kaiser-Wilhelms-Akademie für das militärärztliche Bildungswesen"
411411
email = "rbeck@example.org"
412412
familyName = "Beck-Dülmen"
@@ -416,50 +416,50 @@ with name "db/alice"::
416416
orcidId = "0000-0002-3267"
417417
}, (user){
418418
createId = "simple/root"
419-
createTime = 2023-06-28 12:22:34+02:00
419+
createTime = 2025-12-01 15:32:07+01:00
420420
id = 7
421421
modId = "simple/root"
422-
modTime = 2023-06-28 12:22:34+02:00
422+
modTime = 2025-12-01 15:32:07+01:00
423423
fullName = "Data Ingester"
424424
name = "simple/dataingest"
425425
}, (user){
426426
createId = "simple/root"
427-
createTime = 2023-06-28 12:22:34+02:00
427+
createTime = 2025-12-01 15:32:07+01:00
428428
id = 8
429429
modId = "simple/root"
430-
modTime = 2023-06-28 12:22:34+02:00
430+
modTime = 2025-12-01 15:32:07+01:00
431431
fullName = "IDS reader"
432432
name = "simple/idsreader"
433433
}, (user){
434434
createId = "simple/root"
435-
createTime = 2023-06-28 12:22:34+02:00
435+
createTime = 2025-12-01 15:32:07+01:00
436436
id = 9
437437
modId = "simple/root"
438-
modTime = 2023-06-28 12:22:34+02:00
438+
modTime = 2025-12-01 15:32:07+01:00
439439
fullName = "Pub reader"
440440
name = "simple/pubreader"
441441
}, (user){
442442
createId = "simple/root"
443-
createTime = 2023-06-28 12:22:34+02:00
443+
createTime = 2025-12-01 15:32:07+01:00
444444
id = 10
445445
modId = "simple/root"
446-
modTime = 2023-06-28 12:22:34+02:00
446+
modTime = 2025-12-01 15:32:07+01:00
447447
fullName = "Root"
448448
name = "simple/root"
449449
}, (user){
450450
createId = "simple/root"
451-
createTime = 2023-06-28 12:22:34+02:00
451+
createTime = 2025-12-01 15:32:07+01:00
452452
id = 11
453453
modId = "simple/root"
454-
modTime = 2023-06-28 12:22:34+02:00
454+
modTime = 2025-12-01 15:32:07+01:00
455455
fullName = "User Office"
456456
name = "simple/useroffice"
457457
}, (user){
458458
createId = "simple/root"
459-
createTime = 2023-06-28 15:06:06+02:00
459+
createTime = 2025-12-01 16:35:16+01:00
460460
id = 12
461461
modId = "simple/root"
462-
modTime = 2023-06-28 15:06:06+02:00
462+
modTime = 2025-12-01 16:35:16+01:00
463463
name = "db/alice"
464464
}]
465465
done

‎doc/src/tutorial-config.rst‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ program now accepts::
2929
[--no-check-certificate] [--http-proxy HTTP_PROXY]
3030
[--https-proxy HTTPS_PROXY] [--no-proxy NO_PROXY]
3131

32-
optional arguments:
32+
options:
3333
-h, --help show this help message and exit
3434
-c CONFIGFILE, --configfile CONFIGFILE
3535
config file
@@ -48,7 +48,7 @@ So there is a command line option ``-w URL``. Let's try::
4848

4949
$ python config.py -w 'https://icat.example.com:8181'
5050
Connect to https://icat.example.com:8181
51-
ICAT version 5.0.1
51+
ICAT version 6.2.0
5252

5353
(Again, you may need to add the ``--no-check-certificate`` flag to the
5454
command line if your ICAT server does not have a trusted SSL
@@ -67,7 +67,7 @@ Now you can do the following::
6767

6868
$ python config.py -s myicat
6969
Connect to https://icat.example.com:8181
70-
ICAT version 5.0.1
70+
ICAT version 6.2.0
7171

7272
The command line option ``-s SECTION`` selects a section in the
7373
configuration file to read options from.
@@ -82,7 +82,7 @@ If you run this in the same way as above, you'll get::
8282

8383
$ python config-with-ids.py -s myicat
8484
Connect to https://icat.example.com:8181
85-
ICAT version 5.0.1
85+
ICAT version 6.2.0
8686
No IDS configured
8787

8888
But if you indicate the URL to IDS with the command line option
@@ -98,7 +98,7 @@ You'll get something like::
9898

9999
$ python config-with-ids.py -s myicat
100100
Connect to https://icat.example.com:8181
101-
ICAT version 5.0.1
101+
ICAT version 6.2.0
102102
Connect to https://icat.example.com:8181
103-
IDS version 1.12.0
103+
IDS version 2.1.1
104104

0 commit comments

Comments
 (0)