pymaid.get_user_list

pymaid.get_user_list(remote_instance=None)

Get list of users.

Parameters:

remote_instance (CatmaidInstance) – If not passed directly, will try using global.

Returns:

DataFrame in which each row represents a user:

   id  login  full_name  first_name  last_name  color
0
1
...

Return type:

pandas.DataFrame

Examples

>>> user_list = pymaid.get_user_list()
>>> # To search for e.g. user ID 22
>>> user_list.set_index('id', inplace=True)
>>> user_list.loc[22]
id                                  22
login                      mustermannm
full_name          Michaela Mustermann
first_name                     Michael
last_name                   Mustermann
color         [0.91389, 0.877853, 1.0]
>>> user_list.reset_index(inplace=True)
>>> # To convert into a classic dict
>>> d = user_list.set_index('id').T.to_dict()
>>> d[22]['first_name']
... Michaela