Skip to content

Latest commit

 

History

History
84 lines (59 loc) · 1.94 KB

README.md

File metadata and controls

84 lines (59 loc) · 1.94 KB
Raw

carto-auth

PyPI version PyPI downloads Tests

Python library to authenticate with CARTO.

Install

pip install carto-auth

To install the CARTO DW extension:

pip install carto-auth[carto-dw]

Installing from source

git clone https://github.com/cartodb/carto-auth
cd carto-auth
pip install .

Usage

from carto_auth import CartoAuth

# Authentication
carto_auth = CartoAuth.from_oauth()
# carto_auth = CartoAuth.from_m2m("./carto_credentials.json")

# Get api base url
api_base_url = carto_auth.get_api_base_url()

# Get access token
access_token = carto_auth.get_access_token()

# CARTO Data Warehouse
carto_dw_project, carto_dw_token = carto_auth.get_carto_dw_credentials()
carto_dw_client = carto_auth.get_carto_dw_client()

For more information, check the examples section.

Development

Make commands:

  • init: create the environment and install dependencies
  • lint: run linter (black + flake8)
  • test: run tests (pytest)
  • docs: build the documentation
  • publish-pypi: publish package in pypi.org
  • publish-test-pypi: publish package in test.pypi.org
  • clean: remove the environment

Check the development documentation section.

Contributors

Release

The release to PyPI requires an API token and setting the following file locally with the token: ~/.pypirc

[distutils]
index-servers =
    carto-auth

[carto-auth]
repository = https://upload.pypi.org/legacy/
username = __token__
password = <PyPI token>