Metadata-Version: 2.1
Name: pycounts_rory
Version: 0.1.1
Summary: A word count calculator
License: MIT
Author: Rory White
Requires-Python: >=3.9
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Dist: matplotlib (>=3.8.2)
Description-Content-Type: text/markdown

## Installation

```bash
$ pip install pycounts_rory
```

## Usage

`pycounts_rory` can be used to count words in a text file and plot results as follows:

```python
from pycounts_rory.pycounts_rory import count_words
from pycounts_rory.plotting import plot_words
import matplotlib.pyplot as plt

file_path = "test.txt"  # path to your file
counts = count_words(file_path)
fig = plot_words(counts, n=10)
plt.show()
```

For full documentation see: [https://pycounts-rory.readthedocs.io/en/latest/](https://pycounts-rory.readthedocs.io/en/latest/)

## Contributing

Interested in contributing? Check out the contributing guidelines. 
Please note that this project is released with a Code of Conduct. 
By contributing to this project, you agree to abide by its terms.

## License

`pycounts_rory` was created by Rory White. It is licensed under the terms of the MIT license.

## Credits

`pycounts_rory` was created with 
[`cookiecutter`](https://cookiecutter.readthedocs.io/en/latest/) and 
the `py-pkgs-cookiecutter` 
[template](https://github.com/py-pkgs/py-pkgs-cookiecutter).
