From 8c6346ee05837ffb8adcbbb6c2fe12023cd4108a Mon Sep 17 00:00:00 2001 From: Christian Schreinemachers <42220742+Cs137@users.noreply.github.com> Date: Thu, 11 Jan 2024 23:16:48 +0100 Subject: [PATCH] link example files in example readme (#16) * link example files in example readme * rename example files --- examples/{00.py => 00-read-items.py} | 0 ...01.py => 01-download-timestamp-archive.py} | 0 ...2.py => 02-patch-metadata-per-category.py} | 0 .../{03.py => 03-experiment-file-handling.py} | 0 ...{04.py => 04-create-teamgroup-add-user.py} | 0 examples/{05.py => 05-create-modify-item.py} | 0 examples/{06.py => 06-create-users.py} | 0 .../{07.py => 07-patch-sysadmin-settings.py} | 0 ...{08.py => 08-create-items-add-metadata.py} | 0 examples/README.md | 38 +++++++++++++------ 10 files changed, 26 insertions(+), 12 deletions(-) rename examples/{00.py => 00-read-items.py} (100%) rename examples/{01.py => 01-download-timestamp-archive.py} (100%) rename examples/{02.py => 02-patch-metadata-per-category.py} (100%) rename examples/{03.py => 03-experiment-file-handling.py} (100%) rename examples/{04.py => 04-create-teamgroup-add-user.py} (100%) rename examples/{05.py => 05-create-modify-item.py} (100%) rename examples/{06.py => 06-create-users.py} (100%) rename examples/{07.py => 07-patch-sysadmin-settings.py} (100%) rename examples/{08.py => 08-create-items-add-metadata.py} (100%) diff --git a/examples/00.py b/examples/00-read-items.py similarity index 100% rename from examples/00.py rename to examples/00-read-items.py diff --git a/examples/01.py b/examples/01-download-timestamp-archive.py similarity index 100% rename from examples/01.py rename to examples/01-download-timestamp-archive.py diff --git a/examples/02.py b/examples/02-patch-metadata-per-category.py similarity index 100% rename from examples/02.py rename to examples/02-patch-metadata-per-category.py diff --git a/examples/03.py b/examples/03-experiment-file-handling.py similarity index 100% rename from examples/03.py rename to examples/03-experiment-file-handling.py diff --git a/examples/04.py b/examples/04-create-teamgroup-add-user.py similarity index 100% rename from examples/04.py rename to examples/04-create-teamgroup-add-user.py diff --git a/examples/05.py b/examples/05-create-modify-item.py similarity index 100% rename from examples/05.py rename to examples/05-create-modify-item.py diff --git a/examples/06.py b/examples/06-create-users.py similarity index 100% rename from examples/06.py rename to examples/06-create-users.py diff --git a/examples/07.py b/examples/07-patch-sysadmin-settings.py similarity index 100% rename from examples/07.py rename to examples/07-patch-sysadmin-settings.py diff --git a/examples/08.py b/examples/08-create-items-add-metadata.py similarity index 100% rename from examples/08.py rename to examples/08-create-items-add-metadata.py diff --git a/examples/README.md b/examples/README.md index 362cf35..b9ae3bd 100644 --- a/examples/README.md +++ b/examples/README.md @@ -2,50 +2,64 @@ Work in progress! -# 00.py +# [00-read-items.py] Read all items. -# 01.py +# [01-download-timestamp-archive.py] Download all the timestamp archive zip created in the past 7 days. -# 02.py +# [02-patch-metadata-per-category.py] Look for all items of a particular category and patch the metadata if it is empty. -# 03.py +# [03-experiment-file-handling.py] Upload, download and delete a file in an experiment. -# 04.py +# [04-create-teamgroup-add-user.py] Create a teamgroup and add a user in it. -# 05.py +# [05-create-modify-item.py] Create an item in the database and modify it. -# 06.py +# [06-create-users.py] Create users in batch. -# 07.py +# [07-patch-sysadmin-settings.py] Patch instance config: modify the settings of the Sysadmin Panel. -# 08.py +# [08-create-items-add-metadata.py] Read a CSV file for samples, create them in the database with metadata, tags and links. -# 09-import-csv.py +# [09-import-csv.py] Read a CSV file containing a list of antibodies and import them in the resource database using the metadata/extra fields. -# 10-date-time-conversions.py +# [10-date-time-conversions.py] Work with date-time data formats with a demonstration of doing statistics with experiments data. -# 11-resources-categories.py +# [11-resources-categories.py] Create and edit a Resources Category (Items types). + +[00-read-items.py]: https://github.com/elabftw/elabapi-python/blob/master/examples/00-read-items.py +[01-download-timestamp-archive.py]: https://github.com/elabftw/elabapi-python/blob/master/examples/01-download-timestamp-archive.py +[02-patch-metadata-per-category.py]: https://github.com/elabftw/elabapi-python/blob/master/examples/02-patch-metadata-per-category.py +[03-experiment-file-handling.py]: https://github.com/elabftw/elabapi-python/blob/master/examples/03-experiment-file-handling.py +[04-create-teamgroup-add-user.py]: https://github.com/elabftw/elabapi-python/blob/master/examples/04-create-teamgroup-add-user.py +[05-create-modify-item.py]: https://github.com/elabftw/elabapi-python/blob/master/examples/05-create-modify-item.py +[06-create-users.py]: https://github.com/elabftw/elabapi-python/blob/master/examples/06-create-users.py +[07-patch-sysadmin-settings.py]: https://github.com/elabftw/elabapi-python/blob/master/examples/07-patch-sysadmin-settings.py +[08-create-items-add-metadata.py]: https://github.com/elabftw/elabapi-python/blob/master/examples/08-create-items-add-metadata.py +[09-import-csv.py]: https://github.com/elabftw/elabapi-python/blob/master/examples/09-import-csv.py +[10-date-time-conversions.py]: https://github.com/elabftw/elabapi-python/blob/master/examples/10-date-time-conversions.py +[11-resources-categories.py]: https://github.com/elabftw/elabapi-python/blob/master/examples/11-resources-categories.py +