<commit_before>Caltrain retweet bot
====================

Retweet an account's tweets when certain search terms are found.

Getting started
---------------

* `pip install -r requirements.txt`
* Copy `default.conf.sample` to `default.conf`
* Define search criteria and Twitter app tokens in configuration file
* If necessary, adjust `number_tweets_to_retrieve` on every call in configuration file
* Run script frequently (e.g. every minute through a cron job, dependent on volume and frequency of tweets) to retweet `number_of_tweets_to_retrieve` most recent tweets containing at least one of the comma-separated `search_terms`
<commit_msg>Improved README.<commit_after>Caltrain retweet bot
====================

Retweet an account's tweets when certain search terms are found.

Getting started
---------------

* `pip install -r requirements.txt`.
* Copy the configuration file `default.conf.sample` to `default.conf`.
* Define search criteria, Twitter app tokens and, as required, ignored search terms in the configuration file.
* If necessary, update `number_tweets_to_retrieve` in the configuration file. This value indicates the number of tweets to lookup on every call. Increase or decrease depending on the account's tweeting frequency.
* Run script frequently (e.g. every minute through a cron job, dependent on volume and frequency of tweets) to retweet `number_of_tweets_to_retrieve` most recent tweets containing at least one of the comma-separated `search_terms`.

{'fraction_non_alphanumeric': 0.1016260162601626, 'fraction_numerical': 0.0, 'mean_word_length': 4.81496062992126, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '4903411', 'n_tokens_mistral': 387, 'n_tokens_neox': 362, 'n_words': 177}