We need examples!

[chayim]

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.

[santosh]

What are some action items?

[chayim]

@santosh Off the top of my head I think of:

• Execute simple get/set commands
• Execute actions with piplines
• Redis connection examples (ssl, cluster, credentialed, etc) - generally the init class (Create connection example notebooks and link to the docs #1786)
• Installing (with and without hiredis) then running set/get
• Decoding (or not!) example

[dogukanteber]

@chayim I would like to hop on that. Can you give a more detailed description of how should one construct these examples?

[chayim]

@dogukanteber awesome! Sure, here's a detailed process based on what's now in. To write jupyter notebooks (I'm awful at this!). I learned from this tutorial, and to be honest, I use a VSCode plugin when I need to edit things.

1. Add your new notebook (or edit an exiting file) to docs/examples.
2. Add your notebook to docs/examples.rst
3. Create a new virtualenv and ensure you have dev dependencies ready (pip install -r dev_requirements.txt)
4. To test the things you've built and see how they look in the generated documentation run invoke build-docs
5. Go to docs/_build/html )(this is where the files are generated), and run python3 -m http.server
6. Open your browser to http://localhost:8080 and view the docs.

[chayim]

Reopening - sorry didn't mean to close this.