Metadata-Version: 2.1
Name: charfreq
Version: 23.8.2
Summary: Get character frequency inside files
Project-URL: Repository, https://github.com/mark-bromell/charfreq
Project-URL: Bug Tracker, https://github.com/mark-bromell/charfreq/issues
Author: Mark Bromell
License: Copyright (c) 2012-2023 Mark Bromell
        
        Permission is hereby granted, free of charge, to any person obtaining
        a copy of this software and associated documentation files (the
        "Software"), to deal in the Software without restriction, including
        without limitation the rights to use, copy, modify, merge, publish,
        distribute, sublicense, and/or sell copies of the Software, and to
        permit persons to whom the Software is furnished to do so, subject to
        the following conditions:
        
        The above copyright notice and this permission notice shall be
        included in all copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
        EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
        MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
        NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
        LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
        OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
        WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
License-File: LICENSE
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.8
Description-Content-Type: text/markdown

# charfreq

Get the frequency of characters in your files!
Outputs JSON with character counts

## Install

```shell
pip3 install charfreq
```

## Example usage

```shell
charfreq --only "[()]" ./**/*.py
```

This outputs the following JSON
```json
{
    "(": 83281,
    ")": 83286
}
```

### More random examples

```shell
# Have a look at the options available
charfreq --help

# Check a file
charfreq script.py

# Check many files
charfreq script.py test.py api.js

# Test all py files recursively using glob (only tested on bash shell)
charfreq ./**/*.py

# Use multiple globs! (only tested on bash shell)
charfreq ./**/*.py ./**/*.html

# Exclude characters based on regex
charfreq --exclude "[a-zA-Z]" ./**/*.py

# Only capture characters based on regex
charfreq --only "[a-zA-Z]" ./**/*.py
```
