<commit_before>
#Introduction

ComicStreamer is a media server app for sharing a library of comic files via a simple REST API to client applications.  It allows for searching for comics based on a rich set of metadata including fields like series name, title, publisher, story arcs, characters, and creator credits.

A web interface is also available for searching and viewing comics files.

It's best used on libraries that have been tagged internally with tools like ComicTagger (http://code.google.com/p/comictagger/) or ComicRack (http://comicrack.cyolito.com/). However, even without tags, it will try to parse out some information from the filename (usually series, issue number, and publication year).

ComicStreamer is very early ALPHA stages, and may be very flakey, eating up memory and CPU cycles. In particular, with very large datasets, filters on the sub-lists (characters, credits, etc. ) can be slow.

#Requirements 

*python 2.7

(via pip):
*tornado
*sqlalchemy > 0.9
*watchdog
*dateutil
*pil
*configobj
*comictagger
   
(Note: on some ubuntu releases it may be better to get PIL from ubuntu apt package "python-imaging", rather than via pip)


#Installation

Just unzip somewhere.

Settings and database are kept in user folder:
    On unix (mac,linux) it's "~/.ComicStreamer"
    On windows "%APPDATA%\ComicStreamer"


#Running

Just run "comicstreamer" in the base folder (on windows you may want to rename it comicstreamer.py)

Open up a web browser to "http://localhost:8888"

*Use "--help" option to list options

*The first run will require at least one folder with comics in it to be passed in.

*Use the "--reset" option to wipe and rebuild the database
<commit_msg>markdown fixes<commit_after>
Introduction
------------

ComicStreamer is a media server app for sharing a library of comic files via a simple REST API to client applications.  It allows for searching for comics based on a rich set of metadata including fields like series name, title, publisher, story arcs, characters, and creator credits.

A web interface is also available for searching and viewing comics files.

It's best used on libraries that have been tagged internally with tools like ComicTagger (http://code.google.com/p/comictagger/) or ComicRack (http://comicrack.cyolito.com/). However, even without tags, it will try to parse out some information from the filename (usually series, issue number, and publication year).

ComicStreamer is very early ALPHA stages, and may be very flakey, eating up memory and CPU cycles. In particular, with very large datasets, filters on the sub-lists (characters, credits, etc. ) can be slow.

Requirements 
------------

* python 2.7

(via pip):
* tornado
* sqlalchemy > 0.9
* watchdog
* dateutil
* pil
* configobj
* comictagger
   
(Note: on some ubuntu releases it may be better to get PIL from ubuntu apt package "python-imaging", rather than via pip)


Installation
------------

Just unzip somewhere.

Settings and database are kept in user folder:
* On unix (mac,linux) it's "~/.ComicStreamer"
* On windows "%APPDATA%\ComicStreamer"


Running
-------

Just run "comicstreamer" in the base folder (on windows you may want to rename it comicstreamer.py)

Open up a web browser to "http://localhost:8888"

* Use "--help" option to list options
* The first run will require at least one folder with comics in it to be passed in.
* Use the "--reset" option to wipe and rebuild the database

{'fraction_non_alphanumeric': 0.07835712205068453, 'fraction_numerical': 0.00466064666472473, 'mean_word_length': 4.035190615835777, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 5, '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': '5335997', 'n_tokens_mistral': 984, 'n_tokens_neox': 919, 'n_words': 491}