<commit_before>ArchiveIMAP
===========

ArchiveIMAP is a tool to keep an email account in version control. It's a
pretty simple wrapper around OfflineIMAP and git. The commit message is what
OfflineIMAP prints to stdout while running.

Usage
-----

Make sure OfflineIMAP and git are both installed and that OfflineIMAP is
properly configured. If you want to archive all accounts in OfflineIMAP,
using config files in the default locations and the system git author,
this is all that is needed. For other configurations, options can be set in
a configuration file or at the command line. The command line takes
precedence over the configuration file.

Configuration
-------------

The configuration file defaults to ~/.archiveimaprc and has a single section
named Settings. The following options are available:

* accounts: a comma seperated list of accounts to sync and put in git. Accounts must be defined in the offlineimap configuration file. Defaults to whatever accounts offlineimap is configured to sync.
* offlineimap-config: the path to the offlineimap configuration file. Defaults to ~/.offlineimaprc
* author: The author to use when making commits in git. Defaults to whatever git is configured to use by default.
* quiet: True or False. Controls whether to output status to stdout as well as logging to git commit message. Defaults to False.<commit_msg>add a line to the readme about the commandline options<commit_after>ArchiveIMAP
===========

ArchiveIMAP is a tool to keep an email account in version control. It's a
pretty simple wrapper around OfflineIMAP and git. The commit message is what
OfflineIMAP prints to stdout while running.

Usage
-----

Make sure OfflineIMAP and git are both installed and that OfflineIMAP is
properly configured. If you want to archive all accounts in OfflineIMAP,
using config files in the default locations and the system git author,
this is all that is needed. For other configurations, options can be set in
a configuration file or at the command line. The command line takes
precedence over the configuration file.

Configuration
-------------

The configuration file defaults to ~/.archiveimaprc and has a single section
named Settings. The following options are available:

* accounts: a comma seperated list of accounts to sync and put in git. Accounts must be defined in the offlineimap configuration file. Defaults to whatever accounts offlineimap is configured to sync.
* offlineimap-config: the path to the offlineimap configuration file. Defaults to ~/.offlineimaprc
* author: The author to use when making commits in git. Defaults to whatever git is configured to use by default.
* quiet: True or False. Controls whether to output status to stdout as well as logging to git commit message. Defaults to False.

See archiveimap -h for the command line options.
{'fraction_non_alphanumeric': 0.049663001064207166, 'fraction_numerical': 0.0, 'mean_word_length': 4.3107344632768365, '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': '552008', 'n_tokens_mistral': 695, 'n_tokens_neox': 666, 'n_words': 422}