redis-py icon indicating copy to clipboard operation
redis-py copied to clipboard

Published 20 hours ago • verified publisher icon redis

We need examples!

Open chayim opened this issue 3 years ago • 12 comments

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.

chayim avatar Nov 23 '21 13:11 chayim

What are some action items?

santosh avatar Dec 01 '21 14:12 santosh

@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 (#1786)
  • [ ] Installing (with and without hiredis) then running set/get
  • [ ] Decoding (or not!) example

chayim avatar Dec 01 '21 18:12 chayim

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

dogukanteber avatar Jan 26 '22 15:01 dogukanteber

@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 avatar Jan 27 '22 10:01 chayim

Reopening - sorry didn't mean to close this.

chayim avatar Feb 06 '22 13:02 chayim

Hi @chayim, I don't know if you still need help on this issue, but I created an example notebook of Redis pipelines at #2240

Iglesys347 avatar Jun 20 '22 11:06 Iglesys347

I left this open for exactly that reason @Iglesys347 . I tagged you there.

chayim avatar Jun 21 '22 13:06 chayim

There is a lack of timeseries tutorials, for instance

Garito avatar Jul 07 '22 13:07 Garito

@sav-norem. Wanna?

chayim avatar Sep 01 '22 12:09 chayim

Hey @chayim are contributions on this issue still being entertained?

Would love to add some examples..

LX5321 avatar Mar 13 '23 10:03 LX5321

@LX5321 always :D. More than entertained - we'd love them.

chayim avatar Mar 15 '23 12:03 chayim

wandering about the internet, I have come across some posts like: https://realpython.com/python-redis/#getting-started

Any objection to posting more of these?

CarlFK avatar Feb 19 '24 18:02 CarlFK