<commit_before>About
=====

This project is a Python library which implements a generic concurrent tree-crawling algorithm. In practice, it can be used in tasks that require a couple of crawling threads to explore a tree-like structure e.g. when downloading documents from a hierarchical web site.

This documents contains a quite high-level description of the library. Apart from it, there are some documents placed on `http://github.com/mkobos/tree\_crawler/wiki <http://github.com/mkobos/tree_crawler/wiki>`_ which deal with some more detailed issues:

- design of the library and creating one's own crawler using the library,
- description of the concurrent tree crawling algorithm.

Main use-cases of the library
-----------------------------
<commit_msg>Fix typo in README<commit_after>About
=====

This project is a Python library which implements a generic concurrent tree-crawling algorithm. In practice, it can be used in tasks that require a couple of crawling threads to explore a tree-like structure e.g. when downloading documents from a hierarchical web site.

This document contains a quite high-level description of the library. Apart from it, there are some documents placed on `http://github.com/mkobos/tree\_crawler/wiki <http://github.com/mkobos/tree_crawler/wiki>`_ which deal with some more detailed issues:

- design of the library and creating one's own crawler using the library,
- description of the concurrent tree crawling algorithm.

Main use-cases of the library
-----------------------------

{'fraction_non_alphanumeric': 0.09580052493438321, 'fraction_numerical': 0.0, 'mean_word_length': 3.7955974842767297, 'pattern_counts': {'":': 0, '<': 5, '<?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': 2, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '6359397', 'n_tokens_mistral': 382, 'n_tokens_neox': 361, 'n_words': 193}