CARTOframes

A Python package for integrating CARTO maps, analysis, and data services into data science workflows.

This version includes breaking changes, check the CHANGELOG for more information

Authentication

Introduction

In this guide, our purpose is to focus on the basics of authentication in CARTOframes.

To visualize your local data with CARTOframes, you don’t need to be authenticated.

Authentication is needed to set up your credentials to save your data and visualizations to CARTO or to use the Location Data Services or the Data Observatory. In these cases, it’s required to have a CARTO account.

Get your Master API Key

Once you have created an account, you need to get you Master API Key. The API keys page can be accesed from your dashboard. Once there, click on your avatar to open the dashboard menu. The API keys link will be shown.

API Keys link - CARTO Dashboard

Now that you are at your API Keys page, copy the Master API Key to use in the next section.

Master API Key - CARTO Dashboard

Setting default Credentials

With set_default_credentials, the same user’s authentication will be used by every CARTOframes component. There are different ways to set them but we encourage you to use the one that reads the credentials from a JSON file.

1
2
3
from cartoframes.auth import set_default_credentials

set_default_credentials('creds.json')

Example creds.json file:

1
2
3
4
{
  "username": "YOUR_USERNAME",
  "api_key": "YOUR_API_KEY"
}

Credential parameters

  • username: your CARTO account username
  • api_key: API Key of user’s CARTO account. If the data to be accessed is public, it can be set to default_public.
  • base_url: only needed for on premise or custom installations. It is usually of the form https://username.carto.com/ for user username. On premises installation (and others) have a different URL pattern.

Conclusion

You have learnt how to authenticate to CARTO reading your credentials from a file. Check the reference to learn more about how to manage your credentials.