search

redis / redis-py

Redis Python client
MIT License
12.67k stars 2.53k forks source link

We need examples! #1744

Open chayim opened 2 years ago

chayim commented 2 years ago

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 commented 2 years ago

What are some action items?

chayim commented 2 years ago

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

dogukanteber commented 2 years ago

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

chayim commented 2 years ago

@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 devrequirements.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 commented 2 years ago

Reopening - sorry didn't mean to close this.

Iglesys347 commented 2 years ago

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

chayim commented 2 years ago

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

Garito commented 2 years ago

There is a lack of timeseries tutorials, for instance

chayim commented 2 years ago

@sav-norem. Wanna?

LX5321 commented 1 year ago

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

Would love to add some examples..

chayim commented 1 year ago

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

CarlFK commented 9 months ago

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?