fix both README

Author: NicolasCARPi

README.md

@@ -28,7 +28,29 @@ pip install elabapi-python
 
 # Usage
 
-See the [examples folder](./examples).
+## Getting started
+The easiest way to get started is to look at an example script: [00-getting-started.py](./examples/00-getting-started.py).
+
+Find more examples in the [examples folder](./examples).
+
+## Basic concepts
+
+~~~python
+import elabapi_python
+# Initialize a configuration object from the library
+configuration = elabapi_python.Configuration()
+# Set the host
+configuration.host = "https://eln.example.org/api/v2"
+# Create an API client object with our configuration
+api_client = elabapi_python.ApiClient(configuration)
+# Set the Api Key in Authorization header
+api_client.set_default_header(header_name='Authorization', header_value=5-abc123...)
+
+# Depending on your needs, instantiate the correct object with api_client as argument
+info_client = elabapi_python.InfoApi(api_client)
+exp_client = elabapi_python.ExperimentsApi(api_client)
+items_client = elabapi_python.ItemsApi(api_client)
+~~~
 
 # Unofficial documentation
 

examples/README.md

@@ -1,79 +1,5 @@
 # Examples for using this library
 
-Work in progress!
+This folder contains many examples showcasing how to use the library. Start with [00-getting-started.py](./00-getting-started.py).
 
-# [00-read-items.py](./00-read-items.py)
-
-Read all items.
-
-# [01-download-timestamp-archive.py](./01-download-timestamp-archive.py)
-
-Download all the timestamp archive zip created in the past 7 days.
-
-# [02-patch-metadata-per-category.py](./02-patch-metadata-per-category.py)
-
-Look for all items of a particular category and patch the metadata if it is empty.
-
-# [03-experiment-file-handling.py](./03-experiment-file-handling.py)
-
-Upload, download and delete a file in an experiment.
-
-# [04-create-teamgroup-add-user.py](./04-create-teamgroup-add-user.py)
-
-Create a teamgroup and add a user in it.
-
-# [05-create-modify-item.py](./05-create-modify-item.py)
-
-Create an item in the database and modify it.
-
-# [06-create-users.py](./06-create-users.py)
-
-Create users in batch.
-
-# [07-patch-sysadmin-settings.py](./07-patch-sysadmin-settings.py)
-
-Patch instance config: modify the settings of the Sysadmin Panel.
-
-# [08-create-items-add-metadata.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).
-
-# [12-experiments-export-pdf.py](./12-experiments-export-pdf.py)
-
-Look for all timestamped experiments last week for a particular user and save a pdf locally.
-
-# [13-events.py](./13-events.py)
-
-Get a list of events (booked slots) for the current team.
-
-# [14-fix-user-exp-permissions.py](./14-fix-user-exp-permissions.py)
-
-Look for all experiments of a given user and adjust permissions of their experiments.
-
-# [15-process-csv-metadata-into-csv-column.py](./15-process-csv-metadata-into-csv-column.py)
-
-Take a CSV file created from eLabFTW export function, and for each row, grab the metadata, and create a new CSV where each Extra Field in the metadata is now a column.
-
-# [16-update-users-emails.py](./16-update-users-emails.py)
-
-Take a CSV file that contains a list of old emails to update and their new value, and generate a .sql file that will update theses values in the database.
-
-# [17-csv-metadata-as-columns.py](./17-csv-metadata-as-columns.py)
-
-Take a CSV file created from eLabFTW export function, and creates a new CSV where it extracts the metadata Extra Fields into a new column.
-
-# [18-archive-users.py](./18-archive-users.py)
-
-Archive users that have been inactive for at least 8 months.
+All files are commented. Feel free to submit your own examples script in a pull request!