bear / python-twitter

A Python wrapper around the Twitter API.
Apache License 2.0
3.41k stars 957 forks source link

More robust examples would go a long way towards adoption. #582

Open changeling opened 6 years ago

changeling commented 6 years ago

It seems that most of the Twitter API modules suffer from a lack of broad coverage in examples. I'd like to suggest more robust examples be added to the project.

Personally, I'm dumping follower/friend lists in their entirety into a SQL dbs, but an example demonstrating the objects themselves would have been a big help in jumpstarting my work. An example of dumping them into some sort of persistence would likely serve adoption better than the current examples.

I'd suggest an example or two demonstrating manipulation or query of an object or two in their entirety, rather than, for example, id and name in the existing example for User. There's a broad range of experience in folks playing with the module, and the docs/examples assume a bit more familiarity than the larger audience would have.

(On a side note, the "python-twitter" naming makes it a real pain to google. Just a thought. I end up using queries prefixed with '"python-twitter" -tweepy -twython -"TwitterAPI"' just to begin narrowing the search down.)

Otherwise, I love the module. This is well-done. Thank you for this.