Metadata-Version: 2.1
Name: initial
Version: 0.2.0
Summary: For testing ws python package.
License: MIT
Author: Ming
Requires-Python: >=3.9,<4.0
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
Requires-Dist: matplotlib (>=3.7.2,<4.0.0)
Requires-Dist: numpy (==1.21.5) ; python_version >= "3.7" and python_version < "3.11"
Description-Content-Type: text/markdown

# initial

For testing ws python package.

## Installation

```bash
$ pip install initial
```

## Usage

`initial` can be used to count words in a text file and plot results as follows:
```python
from initial.initial import count_words
from initial.plotting import plot_words
import matplotlib.pyplot as plt

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

## 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

`initial` was created by Ming. It is licensed under the terms of the MIT license.

## Credits

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

