# wordc
> Small utility to analyze the word frequency in a text file
# đ Quickstart
---
## đž Installation
Using pipx (undoubtedly the best way):
```sh
pipx install wordc
```
OS X & Linux:
```sh
pip3 install wordc
```
Windows:
```sh
pip install wordc
```
# đ§ Development setup
---
```sh
pip install --editable wordc
```
# đ Usage
---
Display the help menu with the `-h` argument
```bash
~ $ wordc -h
```
```bash
usage: wordc [-h] [-e ENCODING] [-c] [-s SIZE] [-t TOP_WORDS] [--version] FILENAME
Utility to list the top word frequency in a document
positional arguments:
FILENAME file to analyze for word frequency
optional arguments:
-h, --help show this help message and exit
-e ENCODING, --encoding ENCODING
Encoding to use when reading file
-c, --chunk Force file chunking irrespective of file size
-s SIZE, --size SIZE Chunk size to use when reading file
-t TOP_WORDS, --top_words TOP_WORDS
Number of top words to list
--version display version number
```
specify the file
```bash
~ $ wordc text_file.txt
4284 the
2192 and
2185 of
1861 a
1685 to
```
File chunking will happen automatically in certain situations:
1. When the (file size / availanle memory) ratio is over 25%
2. When the file size is over 100Mb
File chunking can be forced however by using the `-c` argument.
# <âšī¸> Meta
---
[](https://www.linkedin.com/in/sr-king)
[](https://github.com/Stephen-RA-King)
[](https://pypi.org/project/wordc)
[](https://hub.docker.com/r/sraking/wordc)
[](https://stephen-ra-king.github.io/justpython/)
[](mailto:sking.github@gmail.com)
[](https://github.com/Stephen-RA-King/wordc)
Author: Stephen R A King ([sking.github@gmail.com](mailto:sking.github@gmail.com))
Created with Cookiecutter template: [![pydough][pydough-image]][pydough-url] version 1.3.4
<!-- Markdown link & img dfn's -->
[bandit-image]: https://img.shields.io/badge/security-bandit-yellow.svg
[bandit-url]: https://github.com/PyCQA/bandit
[black-image]: https://img.shields.io/badge/code%20style-black-000000.svg
[black-url]: https://github.com/psf/black
[codeclimate-image]: https://api.codeclimate.com/v1/badges/7fc352185512a1dab75d/maintainability
[codeclimate-url]: https://codeclimate.com/github/Stephen-RA-King/wordc/maintainability
[codecov-image]: https://codecov.io/gh/Stephen-RA-King/wordc/branch/main/graph/badge.svg
[codecov-url]: https://app.codecov.io/gh/Stephen-RA-King/wordc
[codefactor-image]: https://www.codefactor.io/repository/github/Stephen-RA-King/wordc/badge
[codefactor-url]: https://www.codefactor.io/repository/github/Stephen-RA-King/wordc
[codeql-image]: https://github.com/Stephen-RA-King/wordc/actions/workflows/github-code-scanning/codeql/badge.svg
[codeql-url]: https://github.com/Stephen-RA-King/wordc/actions/workflows/github-code-scanning/codeql
[commitizen-image]: https://img.shields.io/badge/commitizen-friendly-brightgreen.svg
[commitizen-url]: http://commitizen.github.io/cz-cli/
[conventional-commits-image]: https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg?style=flat-square
[conventional-commits-url]: https://conventionalcommits.org
[deepsource-image]: https://app.deepsource.com/gh/Stephen-RA-King/wordc.svg/?label=active+issues&show_trend=true
[deepsource-url]: https://app.deepsource.com/gh/Stephen-RA-King/wordc/?ref=repository-badge
[docker-image]: https://github.com/Stephen-RA-King/wordc/actions/workflows/docker-image.yml/badge.svg
[docker-url]: https://github.com/Stephen-RA-King/wordc/actions/workflows/docker-image.yml
[downloads-image]: https://static.pepy.tech/personalized-badge/wordc?period=total&units=international_system&left_color=black&right_color=orange&left_text=Downloads
[downloads-url]: https://pepy.tech/project/wordc
[format-image]: https://img.shields.io/pypi/format/wordc
[isort-image]: https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336
[isort-url]: https://github.com/pycqa/isort/
[lgtm-alerts-image]: https://img.shields.io/lgtm/alerts/g/Stephen-RA-King/wordc.svg?logo=lgtm&logoWidth=18
[lgtm-alerts-url]: https://lgtm.com/projects/g/Stephen-RA-King/wordc/alerts/
[lgtm-quality-image]: https://img.shields.io/lgtm/grade/python/g/Stephen-RA-King/wordc.svg?logo=lgtm&logoWidth=18
[lgtm-quality-url]: https://lgtm.com/projects/g/Stephen-RA-King/wordc/context:python
[license-image]: https://img.shields.io/pypi/l/wordc
[license-url]: https://github.com/Stephen-RA-King/wordc/blob/main/LICENSE
[mypy-image]: http://www.mypy-lang.org/static/mypy_badge.svg
[mypy-url]: http://mypy-lang.org/
[openssf-image]: https://api.securityscorecards.dev/projects/github.com/Stephen-RA-King/wordc/badge
[openssf-url]: https://api.securityscorecards.dev/projects/github.com/Stephen-RA-King/wordc
[pre-commit-image]: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white
[pre-commit-url]: https://github.com/pre-commit/pre-commit
[pre-commit.ci-image]: https://results.pre-commit.ci/badge/github/Stephen-RA-King/wordc/main.svg
[pre-commit.ci-url]: https://results.pre-commit.ci/latest/github/Stephen-RA-King/wordc/main
[pydough-image]: https://img.shields.io/badge/pydough-2023-orange?logo=cookiecutter
[pydough-url]: https://github.com/Stephen-RA-King/pydough
[pypi-url]: https://pypi.org/project/wordc/
[pypi-image]: https://img.shields.io/pypi/v/wordc.svg
[python-version-image]: https://img.shields.io/pypi/pyversions/wordc
[readthedocs-image]: https://readthedocs.org/projects/wordc/badge/?version=latest
[readthedocs-url]: https://wordc.readthedocs.io/en/latest/?badge=latest
[status-image]: https://img.shields.io/pypi/status/wordc.svg
[tests-image]: https://github.com/Stephen-RA-King/wordc/actions/workflows/tests.yml/badge.svg
[tests-url]: https://github.com/Stephen-RA-King/wordc/actions/workflows/tests.yml
[versioning-image]: https://img.shields.io/badge/versioning-semver_2-blue
[versioning-url]: https://semver.org/
[wiki]: https://github.com/Stephen-RA-King/wordc/wiki
Raw data
{
"_id": null,
"home_page": "https://github.com/Stephen-RA-King/wordc",
"name": "wordc",
"maintainer": "Stephen R A King",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "sking.github@gmail.com",
"keywords": "utility",
"author": "Stephen R A King",
"author_email": "sking.github@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/e3/6a/39251d6bec931351cf469b8e07f8e56d02202820e64e123076075bffa459/wordc-1.0.1.tar.gz",
"platform": "Any",
"description": "# wordc\r\n\r\n> Small utility to analyze the word frequency in a text file\r\n\r\n# \ud83d\ude80 Quickstart\r\n\r\n---\r\n\r\n## \ud83d\udcbe Installation\r\n\r\nUsing pipx (undoubtedly the best way):\r\n\r\n```sh\r\npipx install wordc\r\n```\r\n\r\nOS X & Linux:\r\n\r\n```sh\r\npip3 install wordc\r\n```\r\n\r\nWindows:\r\n\r\n```sh\r\npip install wordc\r\n```\r\n\r\n# \ud83d\udd27 Development setup\r\n\r\n---\r\n\r\n```sh\r\npip install --editable wordc\r\n```\r\n\r\n# \ud83d\udcdd Usage\r\n\r\n---\r\n\r\nDisplay the help menu with the `-h` argument\r\n\r\n```bash\r\n~ $ wordc -h\r\n```\r\n\r\n```bash\r\nusage: wordc [-h] [-e ENCODING] [-c] [-s SIZE] [-t TOP_WORDS] [--version] FILENAME\r\n\r\nUtility to list the top word frequency in a document\r\n\r\npositional arguments:\r\n FILENAME file to analyze for word frequency\r\n\r\noptional arguments:\r\n -h, --help show this help message and exit\r\n -e ENCODING, --encoding ENCODING\r\n Encoding to use when reading file\r\n -c, --chunk Force file chunking irrespective of file size\r\n -s SIZE, --size SIZE Chunk size to use when reading file\r\n -t TOP_WORDS, --top_words TOP_WORDS\r\n Number of top words to list\r\n --version display version number\r\n```\r\n\r\nspecify the file\r\n\r\n```bash\r\n~ $ wordc text_file.txt\r\n4284 the\r\n2192 and\r\n2185 of\r\n1861 a\r\n1685 to\r\n```\r\n\r\nFile chunking will happen automatically in certain situations:\r\n\r\n1. When the (file size / availanle memory) ratio is over 25%\r\n2. When the file size is over 100Mb\r\n\r\nFile chunking can be forced however by using the `-c` argument.\r\n\r\n# <\u2139\ufe0f> Meta\r\n\r\n---\r\n\r\n[](https://www.linkedin.com/in/sr-king)\r\n[](https://github.com/Stephen-RA-King)\r\n[](https://pypi.org/project/wordc)\r\n[](https://hub.docker.com/r/sraking/wordc)\r\n[](https://stephen-ra-king.github.io/justpython/)\r\n[](mailto:sking.github@gmail.com)\r\n[](https://github.com/Stephen-RA-King/wordc)\r\n\r\nAuthor: Stephen R A King ([sking.github@gmail.com](mailto:sking.github@gmail.com))\r\n\r\nCreated with Cookiecutter template: [![pydough][pydough-image]][pydough-url] version 1.3.4\r\n\r\n<!-- Markdown link & img dfn's -->\r\n\r\n[bandit-image]: https://img.shields.io/badge/security-bandit-yellow.svg\r\n[bandit-url]: https://github.com/PyCQA/bandit\r\n[black-image]: https://img.shields.io/badge/code%20style-black-000000.svg\r\n[black-url]: https://github.com/psf/black\r\n[codeclimate-image]: https://api.codeclimate.com/v1/badges/7fc352185512a1dab75d/maintainability\r\n[codeclimate-url]: https://codeclimate.com/github/Stephen-RA-King/wordc/maintainability\r\n[codecov-image]: https://codecov.io/gh/Stephen-RA-King/wordc/branch/main/graph/badge.svg\r\n[codecov-url]: https://app.codecov.io/gh/Stephen-RA-King/wordc\r\n[codefactor-image]: https://www.codefactor.io/repository/github/Stephen-RA-King/wordc/badge\r\n[codefactor-url]: https://www.codefactor.io/repository/github/Stephen-RA-King/wordc\r\n[codeql-image]: https://github.com/Stephen-RA-King/wordc/actions/workflows/github-code-scanning/codeql/badge.svg\r\n[codeql-url]: https://github.com/Stephen-RA-King/wordc/actions/workflows/github-code-scanning/codeql\r\n[commitizen-image]: https://img.shields.io/badge/commitizen-friendly-brightgreen.svg\r\n[commitizen-url]: http://commitizen.github.io/cz-cli/\r\n[conventional-commits-image]: https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg?style=flat-square\r\n[conventional-commits-url]: https://conventionalcommits.org\r\n[deepsource-image]: https://app.deepsource.com/gh/Stephen-RA-King/wordc.svg/?label=active+issues&show_trend=true\r\n[deepsource-url]: https://app.deepsource.com/gh/Stephen-RA-King/wordc/?ref=repository-badge\r\n[docker-image]: https://github.com/Stephen-RA-King/wordc/actions/workflows/docker-image.yml/badge.svg\r\n[docker-url]: https://github.com/Stephen-RA-King/wordc/actions/workflows/docker-image.yml\r\n[downloads-image]: https://static.pepy.tech/personalized-badge/wordc?period=total&units=international_system&left_color=black&right_color=orange&left_text=Downloads\r\n[downloads-url]: https://pepy.tech/project/wordc\r\n[format-image]: https://img.shields.io/pypi/format/wordc\r\n[isort-image]: https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336\r\n[isort-url]: https://github.com/pycqa/isort/\r\n[lgtm-alerts-image]: https://img.shields.io/lgtm/alerts/g/Stephen-RA-King/wordc.svg?logo=lgtm&logoWidth=18\r\n[lgtm-alerts-url]: https://lgtm.com/projects/g/Stephen-RA-King/wordc/alerts/\r\n[lgtm-quality-image]: https://img.shields.io/lgtm/grade/python/g/Stephen-RA-King/wordc.svg?logo=lgtm&logoWidth=18\r\n[lgtm-quality-url]: https://lgtm.com/projects/g/Stephen-RA-King/wordc/context:python\r\n[license-image]: https://img.shields.io/pypi/l/wordc\r\n[license-url]: https://github.com/Stephen-RA-King/wordc/blob/main/LICENSE\r\n[mypy-image]: http://www.mypy-lang.org/static/mypy_badge.svg\r\n[mypy-url]: http://mypy-lang.org/\r\n[openssf-image]: https://api.securityscorecards.dev/projects/github.com/Stephen-RA-King/wordc/badge\r\n[openssf-url]: https://api.securityscorecards.dev/projects/github.com/Stephen-RA-King/wordc\r\n[pre-commit-image]: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white\r\n[pre-commit-url]: https://github.com/pre-commit/pre-commit\r\n[pre-commit.ci-image]: https://results.pre-commit.ci/badge/github/Stephen-RA-King/wordc/main.svg\r\n[pre-commit.ci-url]: https://results.pre-commit.ci/latest/github/Stephen-RA-King/wordc/main\r\n[pydough-image]: https://img.shields.io/badge/pydough-2023-orange?logo=cookiecutter\r\n[pydough-url]: https://github.com/Stephen-RA-King/pydough\r\n[pypi-url]: https://pypi.org/project/wordc/\r\n[pypi-image]: https://img.shields.io/pypi/v/wordc.svg\r\n[python-version-image]: https://img.shields.io/pypi/pyversions/wordc\r\n[readthedocs-image]: https://readthedocs.org/projects/wordc/badge/?version=latest\r\n[readthedocs-url]: https://wordc.readthedocs.io/en/latest/?badge=latest\r\n[status-image]: https://img.shields.io/pypi/status/wordc.svg\r\n[tests-image]: https://github.com/Stephen-RA-King/wordc/actions/workflows/tests.yml/badge.svg\r\n[tests-url]: https://github.com/Stephen-RA-King/wordc/actions/workflows/tests.yml\r\n[versioning-image]: https://img.shields.io/badge/versioning-semver_2-blue\r\n[versioning-url]: https://semver.org/\r\n[wiki]: https://github.com/Stephen-RA-King/wordc/wiki\r\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "boilerplate you need to create a Python package.",
"version": "1.0.1",
"project_urls": {
"Bug Tracker": "https://github.com/Stephen-RA-King/wordc/issues",
"CI": "https://github.com/Stephen-RA-King/wordc/actions",
"Documentation": "https://wordc.readthedocs.io/en/latest/",
"Download": "https://github.com/Stephen-RA-King/wordc/archive/refs/heads/main.zip",
"Homepage": "https://github.com/Stephen-RA-King/wordc",
"Release Notes": "https://github.com/Stephen-RA-King/wordc/releases",
"Source Code": "https://github.com/Stephen-RA-King/wordc/"
},
"split_keywords": [
"utility"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "010390a95021b37aa2c5da0f3ea5944f9d6d3bddc94b523df07096ec64f48888",
"md5": "c9077a23a3e274232f1ce6a6054ac96f",
"sha256": "1e42263e5f0c4e5a69d54c0934e0c68c5131e27ed73193de751a66d5c809b3ef"
},
"downloads": -1,
"filename": "wordc-1.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c9077a23a3e274232f1ce6a6054ac96f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 8782,
"upload_time": "2024-05-09T19:49:27",
"upload_time_iso_8601": "2024-05-09T19:49:27.222580Z",
"url": "https://files.pythonhosted.org/packages/01/03/90a95021b37aa2c5da0f3ea5944f9d6d3bddc94b523df07096ec64f48888/wordc-1.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e36a39251d6bec931351cf469b8e07f8e56d02202820e64e123076075bffa459",
"md5": "83d2842e2e782be72316450cac4eea57",
"sha256": "714e8e1cf5b6808b024592c2cc1f1decc92243c509893b48b172926137858876"
},
"downloads": -1,
"filename": "wordc-1.0.1.tar.gz",
"has_sig": false,
"md5_digest": "83d2842e2e782be72316450cac4eea57",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 13161,
"upload_time": "2024-05-09T19:49:28",
"upload_time_iso_8601": "2024-05-09T19:49:28.841900Z",
"url": "https://files.pythonhosted.org/packages/e3/6a/39251d6bec931351cf469b8e07f8e56d02202820e64e123076075bffa459/wordc-1.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-09 19:49:28",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Stephen-RA-King",
"github_project": "wordc",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"requirements": [],
"tox": true,
"lcname": "wordc"
}
JSON
