Metadata-Version: 2.1
Name: words-count
Version: 1.0.0
Summary: CLI tool for that outputs the N (N by default 100) most common n-word (n by default is 3)
    sequence in text.
Home-page: https://github.com/javibravo/words-count
Author: Javier Bravo
Author-email: javibravo85@gmail.com
License: MIT
Description: # Word Count
        
        CLI tool for that outputs the N (N by default 100) most common n-word (n by default is 3) sequence in text, along with a count of how many times each occurred in the text.
        
        The CLI can get the text on 'stdin' with default params:
        ```
        >$ cat text_file.txt | word-count
        ...
        ```
         
        Or using positional arguments:
        ```
        >$ word-count --files text_file.txt
        ...
        >$ word-count --files text_file.txt --number-of-words 4 --top 5
        ...
        ```
        
        ### Important
        
        - It is **not** case sensitive (e.g. “I love\nsandwiches.” is treated the same as "(I LOVE SANDWICHES!!)")
        - When more than 1 file are passed as argument, each file is processed independently but the series of words are counted together.
        
        ## How to install
        
        Install the cli using `pip`
        
        ```
        >$ pip intall words-count
        ...
        ```
        
        Then, it will be available to use:
        
        ```
        >$ words-count --help
        usage: words-count [-h] [-f [FILES ...]] [-n NUMBER_OF_WORDS] [-t TOP]
        
        CLI tool for that outputs the N (N by default 100) most common n-word (n by default is 3) sequence in text, along with a count of how many times each
        occurred in the text.
        
        optional arguments:
          -h, --help            show this help message and exit
          -f [FILES ...], --files [FILES ...]
                                Files path to read
          -n NUMBER_OF_WORDS, --number-of-words NUMBER_OF_WORDS
                                Number of words to group
          -t TOP, --top TOP     Max number of groups of words to output
        ```
        
        ### Examples of use
        
        Process to `stdin`:
        ```
        >$ cat pg2009.txt | words-count
        {
            "of the same": 320,
            "the same species": 126,
            "conditions of life": 125,
            "in the same": 116,
            "of natural selection": 107,
            "from each other": 103,
            "species of the": 98,
            "on the other": 89,
            "the other hand": 81,
            "the case of": 78,
            "the theory of": 75,
        ...
        ```
        
        Use arguments for adjusting the options:
        ```
        words-count --files pg2009.txt --number-of-words 6 --top 5
        {
            "the individuals of the same species": 31,
            "the species of the same genus": 19,
            "we can understand how it is": 13,
            "can understand how it is that": 13,
            "the project gutenberg literary archive foundation": 13
        }
        ```
        
        Process multiple files:
        ```
        words-count --files pg2009.txt pg2009.txt --number-of-words 6 --top 5
        {
            "the individuals of the same species": 62,
            "the species of the same genus": 38,
            "we can understand how it is": 26,
            "can understand how it is that": 26,
            "the project gutenberg literary archive foundation": 26
        }
        ```
        
        
Keywords: count word words text
Platform: UNKNOWN
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Environment :: Console
Classifier: Natural Language :: English
Classifier: Operating System :: Unix
Classifier: Operating System :: MacOS
Classifier: License :: OSI Approved :: MIT License
Description-Content-Type: text/markdown
