Metadata-Version: 2.1
Name: pycounts_toy_python_524
Version: 0.1.0
Summary: A package based on the pycounts tutorial, as part of DSCI 524 Individual Assignment
License: MIT
Author: Gretel Tan
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.4.3)
Description-Content-Type: text/markdown

# pycounts_toy_python_524

A package based on the pycounts tutorial, as part of DSCI 524 Individual Assignment.

## Installation

```bash
$ pip install pycounts_toy_python_524
```

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

```python
from pycounts_toy_python_524.pycounts_toy_python_524 import count_words
from pycounts_toy_python_524.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()
```

## 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_toy_python_524` was created by Gretel Tan. It is licensed under the terms of the MIT license.

## Credits

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

