How to Add Authentication to a STAC Catalog in Leafmap?

[pedro-cf]

Is there a way to include authentication (e.g., Basic Auth) when accessing a STAC catalog in Leafmap?

I'm currently using the following code in a Jupyter Notebook to load STAC catalogs:

import leafmap

catalogs = {
    "Element84 Earth Search": "https://earth-search.aws.element84.com/v1",
    "Microsoft Planetary Computer": "https://planetarycomputer.microsoft.com/api/stac/v1",
}
m = leafmap.Map(center=[40, -100], zoom=4)
m.set_catalog_source(catalogs)
m.add_stac_gui()
m

Some STAC catalogs require authentication (e.g., API keys, Basic Auth). I tried modifying the URL to include credentials, like this:

https://<username>:<password>@stac-api.com

However, this results in the following error:

Retrieving collections...
nonnumeric port: '<password>@stac-api.com'
expected str, bytes or os.PathLike object, not NoneType
cannot unpack non-iterable NoneType object
No collections found.

Is there a proper way to pass authentication credentials when loading a STAC catalog in Leafmap? Any guidance would be appreciated.

Thanks!

[giswqs]

The stac_custom_gui() function builds upon the pystac-client Client.open() method. You should be able to pass in any of those Client.open() parameters to stac_custom_gui() for authentication. I don't have a readily available example for this, but you can give it a try and see if it work.

Here is the list functions being called when using custom STAC catalogs.

leafmap/leafmap/toolbar.py

Line 5175 in cd24114

def stac_custom_gui(m, button_width: Optional[str] = "85px", **kwargs):

leafmap/leafmap/stac.py

Line 1316 in cd24114

def stac_collections(

leafmap/leafmap/stac.py

Line 1229 in cd24114

def stac_client(

leafmap/leafmap/stac.py

Line 1286 in cd24114

client = Client.open(

https://pystac-client.readthedocs.io/en/stable/api.html#pystac_client.Client.open

open(url, headers=None, parameters=None, ignore_conformance=None, modifier=None, request_modifier=None, stac_io=None, timeout=None)

[pedro-cf]

Can't seem to get this to work sadly... I've tried many many options...