Skip to content

Latest commit

 

History

History
43 lines (27 loc) · 1.15 KB

credentials.rst

File metadata and controls

43 lines (27 loc) · 1.15 KB
Raw

Credentials Management

Typical usage

The most common way to input credentials into cartoframes is through the set_default_credentials method, as below. Replace {your_user_name} with your CARTO username and {your_api_key} with your API key, which you can find at https://{your_user_name}.carto.com/your_apps.

from cartoframes.auth import set_default_credentials

set_default_credentials(
    username='{your_user_name}',
    api_key='{your_api_key}'
)

When the data we’re going to use is public, we don’t need the api_key parameter, it’s automatically set to default_public:

from cartoframes.auth import set_default_credentials

set_default_credentials('your_user_name')

You can also set your credentials using the base_url parameter:

from cartoframes.auth import set_default_credentials

set_default_credentials(
    base_url='https://{your_user_name}.carto.com',
    api_key='{your_api_key}'
)

The Credentials class

.. automodule:: cartoframes.auth.credentials
    :noindex:
    :members: