-
Notifications
You must be signed in to change notification settings - Fork 64
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[ Docs - Guides] - Login to CARTO Platform #1057
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, just two minors.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great job!
I have added minor comments to clarify the docs
In this guide, our purpose is to focus on the basics of authentication in CARTOframes. There's a full [Authorization Fundamentals](https://carto.com/developers/fundamentals/authorization/) at CARTO guide to understand how to configure and manage API Keys. | ||
|
||
> To use CARTOframes is not *always* needed to be authenticated. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What about *not always*
from cartoframes.auth import set_default_credentials | ||
|
||
set_default_credentials( |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This form is also allowed:
set_default_credentials('johnsmith', '1a2b3c4d5e6f7g8h')
(Not sure if we should comment this feature here)
from cartoframes.auth import set_default_credentials | ||
|
||
set_default_credentials( |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This form is also allowed:
set_default_credentials('https://johnsmith.carto.com/', '1a2b3c4d5e6f7g8h')
(Not sure if we should comment this feature here)
``` | ||
|
||
The filename is `cartocreds.json` by default, but it can be overwriten. There are [different methods](/developers/cartoframes/reference/#cartoframes-auth-Credentials) to read, update and delete your credentials. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Every time we talk about cartocreds.json
we should clarify that this is in the config directory of the user system to avoid the misunderstanding of the config file to be in .
. In my case, for example, '/home/jesus/.config/cartoframes'
(https://github.com/ActiveState/appdirs/blob/master/appdirs.py#L166)
Related issue: #993