add sample file to retrieve person and group api endpoints data

Author: sszepe

example_gets_person_group.py

@@ -0,0 +1,116 @@
+# This software is licenced under the BSD 3-Clause licence
+# available at https://opensource.org/licenses/BSD-3-Clause
+# and described in the LICENCE file in the root of this project
+
+"""
+Example Python 3 application using the dspace.py API client library to retrieve basic person
+and group information in a DSpace repository
+"""
+
+import logging
+import os
+import sys
+
+from dspace_rest_client.client import DSpaceClient
+
+# Import models as below if needed
+# from dspace_rest_d.models import Community, Collection, Item, Bundle, Bitstream
+
+# Example variables needed for authentication and basic API requests
+# SET THESE TO MATCH YOUR TEST SYSTEM BEFORE RUNNING THE EXAMPLE SCRIPT
+# You can also leave them out of the constructor and set environment variables instead:
+# DSPACE_API_ENDPOINT=
+# DSPACE_API_USERNAME=
+# DSPACE_API_PASSWORD=
+# USER_AGENT=
+DEFAULT_URL = "http://localhost:8080/server/api"
+DEFAULT_USERNAME = "username@test.system.edu"
+DEFAULT_PASSWORD = "password"
+
+USER_UUID = "a5e21324-7d42-4688-947d-6ab76c4673b4"
+GROUP_UUID = "11ba756f-9539-496b-a9de-83a5376df4fc"
+SEARCH_EMAIL = "username@test.system.edu"
+SEARCH_PERSON_QUERY = "Stefan"
+SEARCH_GROUP_QUERY = "Administrator"
+
+# Configuration from environment variables
+URL = os.environ.get("DSPACE_API_ENDPOINT", DEFAULT_URL)
+USERNAME = os.environ.get("DSPACE_API_USERNAME", DEFAULT_USERNAME)
+PASSWORD = os.environ.get("DSPACE_API_PASSWORD", DEFAULT_PASSWORD)
+
+# Instantiate DSpace client
+# Note the 'fake_user_agent' setting here -- this will set a string like the following,
+# to get by Cloudfront:
+# Mozilla/5.0 (Windows NT 6.2; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) \
+# Chrome/39.0.2171.95 Safari/537.36
+# The default is to *not* fake the user agent, and instead use the default of
+# DSpace-Python-REST-Client/x.y.z.
+# To specify a custom user agent, set the USER_AGENT env variable and leave/set
+# fake_user_agent as False
+d = DSpaceClient(
+    api_endpoint=URL, username=USERNAME, password=PASSWORD, fake_user_agent=True
+)
+
+# Authenticate against the DSpace client
+authenticated = d.authenticate()
+if not authenticated:
+    print("Error logging in! Giving up.")
+    sys.exit(1)
+
+# --- PERSON FUNCTIONS ---
+
+# Get all users with pagination
+logging.info("Fetching all users...")
+users = d.get_users(page=0, size=10)
+for user in users:
+    print(f"User: {user.uuid}, Name: {user.name}, Email: {user.email}")
+
+# Get a user by UUID
+logging.info(f"Fetching user by UUID: {USER_UUID}")
+user = d.get_user_by_uuid(USER_UUID)
+if user:
+    print(f"Fetched User: {user.uuid}, Name: {user.name}, Email: {user.email}")
+
+# Search for a user by email
+logging.info(f"Searching user by email: {SEARCH_EMAIL}")
+user = d.search_user_by_email(SEARCH_EMAIL)
+if user:
+    print(f"Found User: {user.uuid}, Name: {user.name}, Email: {user.email}")
+
+# Search users by metadata
+logging.info(f"Searching users by metadata: {SEARCH_PERSON_QUERY}")
+users = d.search_users_by_metadata(query=SEARCH_PERSON_QUERY)
+for user in users:
+    print(f"Matched User: {user.uuid}, Name: {user.name}, Email: {user.email}")
+
+# --- GROUP FUNCTIONS ---
+
+# Get all groups with pagination
+logging.info("Fetching all groups...")
+groups = d.get_groups(page=0, size=10)
+for group in groups:
+    print(f"Group: {group.uuid}, Name: {group.name}")
+
+# Get a group by UUID
+logging.info(f"Fetching group by UUID: {GROUP_UUID}")
+group = d.get_group_by_uuid(GROUP_UUID)
+if group:
+    print(f"Fetched Group: {group.uuid}, Name: {group.name}")
+
+# Search groups by metadata
+logging.info(f"Searching groups by metadata: {SEARCH_GROUP_QUERY}")
+groups = d.search_groups_by_metadata(SEARCH_GROUP_QUERY)
+for group in groups:
+    print(f"Matched Group: {group.uuid}, Name: {group.name}")
+
+# Get subgroups of a group
+logging.info(f"Fetching subgroups for group: {GROUP_UUID}")
+subgroups = d.get_subgroups(GROUP_UUID)
+for subgroup in subgroups:
+    print(f"Subgroup: {subgroup.uuid}, Name: {subgroup.name}")
+
+# Get EPersons in a group
+logging.info(f"Fetching EPersons in group: {GROUP_UUID}")
+epersons = d.get_epersons_in_group(GROUP_UUID)
+for eperson in epersons:
+    print(f"EPerson: {eperson.uuid}, Name: {eperson.name}, Email: {eperson.email}")