Create regular python file in the current folder with meaningful name. It makes sense prefix example files with command category (e.g. string, set, list, hash, etc) to make navigation in the folder easier. Files ending in .py are automatically run by the test suite.
See https://github.com/redis-stack/redis-stack-website#readme for more details.
Examples are standalone python scripts, committed to the doctests directory. These scripts assume that the dependencies from this repository have been installed, as per below.
pip install .[dev,doctest]Note - the CI process, runs the basic black and isort linters against the examples. Assuming
the requirements above have been installed you can run black yourfile.py and isort yourfile.py
locally to validate the linting, prior to CI.
Just include necessary assertions in the example file and run
sh doctests/run_examples.shto test all examples in the current folder.