Metadata-Version: 2.1
Name: mypycounts
Version: 0.1.0
Summary: A package for counting words and others.
License: MIT
Author: Emmanuel Arkoh-Nelson
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.4)
Description-Content-Type: text/markdown

# mypycounts

A package for counting words and others.

## Installation

```bash
$ pip install mypycounts
```

## Usage

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

  ```python
  from mypycounts.mypycounts import count_words
  from mypycounts.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

`mypycounts` was created by Emmanuel Arkoh-Nelson. It is licensed under the terms of the MIT license.

## Credits

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

