plotly / plotly/graphing-library-docs

Use official Redshift driver in docs

Open
#196 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Jupyter Notebook
Stars
59
Forks
72
Avg merge
1d 19h
Merged PRs (30d)
3

Description

Hi there, I maintain redshift_connector.

I noticed https://github.com/plotly/graphing-library-docs/blob/master/_posts/python-v3/databases/redshift.ipynb uses psycopg2. redshift_connector is mentioned here on the plotly website, but this example uses psycopg2. Could you folks consider updating this to use redshift_connector?

redshift_connector supports integration with SQLAlchemy via the Redshift specific SQLAlchemy dialect (sqlalchemy-redshift) as well as a bunch of Redshift specific features such as IAM and Identity provider based authentication as well as support for Redshift native datatypes.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Open _posts/python-v3/databases/redshift.ipynb and inspect the current psycopg2 example first. Update the documented connection example to use redshift_connector, including the relevant Redshift-specific integration described in the issue. Done means the notebook no longer relies on psycopg2 and the example remains valid documentation.

Written by the indexing model from the issue text.

Assessment

Tech stack
jupyter-notebook, python
Domain
databases, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.