redis/redis-py

We need examples!

Open

#1,744 opened on Nov 23, 2021

View on GitHubContributor guide
 (17 comments) (6 reactions) (0 assignees)Python (2,485 forks)batch import
good first issuehelp-wantedmaintenance

Repository metrics

Stars
 (12,019 stars)
PR merge metrics
 (Avg merge 5d) (19 merged PRs in 30d)

Description

In order to help drive adoption, and make it easier for others to get started with redis-py, I'd love to start including examples with the repository. Recently, I introduced a change to start splitting up the documentation - as a first step - which will be part of 4.1.0.

Next - I plan on adding support for jupyter notebooks in our documentation to enable this.

Contributor guide

Research direction
Examine the existing documentation structure in the repository and review the plan for Jupyter notebook integration. Create a simple example demonstrating a common Redis use case, such as connecting to a Redis instance and performing basic operations.
Tech stack
python
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
PythonGitRedis basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90