Skip to content
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

Merged
merged 5 commits into from
Oct 8, 2019
Merged

Conversation

elenatorro
Copy link
Contributor

Related issue: #993

@elenatorro elenatorro requested a review from Jesus89 October 4, 2019 11:23
Copy link
Contributor

@alrocar alrocar left a 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.

cartoframes/auth/credentials.py Outdated Show resolved Hide resolved
docs/developer-center/guides/04-Login-to-CARTO-Platform.md Outdated Show resolved Hide resolved
cartoframes/auth/defaults.py Outdated Show resolved Hide resolved
cartoframes/auth/defaults.py Outdated Show resolved Hide resolved
cartoframes/auth/defaults.py Outdated Show resolved Hide resolved
@elenatorro elenatorro merged commit ec79247 into docs/guides Oct 8, 2019
@elenatorro elenatorro deleted the docs/guides-login branch October 8, 2019 07:47
Copy link
Member

@Jesus89 Jesus89 left a 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.
Copy link
Member

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(
Copy link
Member

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(
Copy link
Member

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.
Copy link
Member

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)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants