pytest-dev / pytest-bdd

BDD library for the py.test runner
https://pytest-bdd.readthedocs.io/en/latest/
MIT License
1.3k stars 219 forks source link

Consider adding a very small working example to the repo and readme #644

Open jzohrab opened 11 months ago

jzohrab commented 11 months ago

Hi there,

(again a repeated thanks for this killer project. It has been fun to work with and really adds a lot to my project.)

When I was getting started out I would have appreciated a running example. I had to sort out some issues with file placement and naming, and just simple organization. The readme and various blogs show how to use it, but having something running to hack at is so much nicer.

My idea is that users could just copy a working set of files into their project or an empty dir, run it, and start from there. Something as simple as:

/ example book.py -- a very simple class book.feature test_book.py

The feature would contain the basics: a background, a few scenarios (possibly with one failing so that users could tweak it), some steps with a parser, some without, and the test_book.py would just pull in all of the features.

If you'd like I can kick off an initial draft and PR a draft back to this repo. Cheers, jz