<commit_before>ComicCleaner
============
Scanning your own comic collection for safekeeping is fun. Corrupted or incomplete archives are not! 
comicCleaner analyzes you comic library and finds all the broken and incomplete {cbr,cbz} files.

## What can it do?

* Find corrupted files in your library
* Find comics that have too few pages, which indicates a valid but incomplete scan.
* Find unwanted pages based on crc and remove them.

###Disclaimer : 
ComicCleaner is for use with comics you scanned yourself or acquired by legal means. I do not condone piracy in any way.
<commit_msg>Add a proper README<commit_after>ComicCleaner
============
Scanning your own comic collection for safekeeping is fun. Corrupted or incomplete archives are not! 
comicCleaner analyzes your comic library and finds all the broken and incomplete {*cbr,cbz*} files.

## How it works:

When ComicCleaner is run without the <code>--clean</code> option it will simply scan your library and report broken comics. Comics that have no or too few pages will also be reported as they indicate an incomplete scan. 

When run with the <code>--clean</code> option Comiccleaner will start the execution by scanning the directory indicated by <code>banned_files_dir</code> and calculate the checksums of the files it contains. An example of a page that could be remove this way is a personal cover you added to your scans and no longer want.

ComicCleaner then scans your library again and when it encounters one of these banned files it will remove it from the comic. The new comic will be saved using the *cbz* format and the old comic will be backed up with a *.bak* extension.

## Usage:

**./comicCleaner.py** [-h] [--clean] [--banned_files_dir BANNED_FILES_DIR] [--dry_run] library_path

**library_path**  
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The location of your library  
**-h, --help**  
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Show this help message and exit  
**--clean**  
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Remove banned files from the comics  
**--banned_files_dir BANNED_FILES_DIR**  
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The directory contaning the banned files.  
**--dry_run**  
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Display information only. No file will be modified

###Disclaimer : 
ComicCleaner is for use with comics you scanned yourself or acquired by legal means. I do not condone piracy in any way.

{'fraction_non_alphanumeric': 0.0959967320261438, 'fraction_numerical': 0.0, 'mean_word_length': 4.944174757281553, 'pattern_counts': {'":': 0, '<': 9, '<?xml version=': 0, '>': 9, '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': '6009454', 'n_tokens_mistral': 702, 'n_tokens_neox': 667, 'n_words': 322}