search-tweets-python
search-tweets-python copied to clipboard
Docs error in README.rst
Describe the bug
In the fast way section of the README.rst file for v2, the example collect_results call does not provide an argument for granularity even though it is required. It should have granularity=False, or the collect_results function should be changed to not require granularity.
To Reproduce
from searchtweets import gen_request_parameters, load_credentials, collect_results
search_args = load_credentials(filename="./.twitter_keys.yaml",
yaml_key="search_tweets_v2",
env_overwrite=False
)
query = gen_request_parameters("snow", results_per_call=100)
tweets = collect_results(query,
max_tweets = 100,
result_stream_args=search_args)
Expected behavior
The granularity parameter should either not be required, or should be set to False in the example. Unfortunately, I'm rate limited so I can't run this can show the output here.
Environment
- OS: macOS Big Sur
- Python 3.9.5
Additional context
Looks like this is the same as #134, and looking at the definition of collect_results here, I think this is fixed, but not on PyPi. This could still cause problems for people setting up this library though because the docs don't match with what people are using.