Metadata-Version: 2.4
Name: markdown-word-count
Version: 0.1.0
Summary: Word counter for raw Markdown files
Home-page: https://github.com/gandreadis/markdown-word-count
Author: Georgios Andreadis
Author-email: info@gandreadis.com
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: license-file
Dynamic: requires-python
Dynamic: summary

# ⬇ Markdown Word Count

[![Python package](https://github.com/gandreadis/markdown-word-count/actions/workflows/python-package.yml/badge.svg)](https://github.com/gandreadis/markdown-word-count/actions/workflows/python-package.yml)

A word counter for raw Markdown files, excluding punctuation, footnotes, and special Markdown or HTML tag syntax.

## 💻 Installation

You will need...

- 🐍 Python 3
- 🐑 PIP3 or a [clone](https://github.com/gandreadis/markdown-word-count.git) of this repo.

## ▶ Usage

### Through PIP

The easiest way is to run:

```
pip install markdown-word-count
```

Then, you'll be able to analyze any file by passing its name (relative path) to the `mwc` script:

```
mwc yourfile.md
```

You can also pass in multiple files or a blob if your shell supports it. This allows for checking all files in a folder, for example.

```
mwc text1.md text2.md
mwc test/*.md
```

### Manually

If you want to clone the repo and run the Python script manually, run:

```
python mwc/cli.py myfile.md
```

If this doesn't work, try `python3` instead of `python`.

## ⛏ Development

Run this to execute all tests:

```
python -m unittest discover
```

## 💬 Ports to Other Programming Languages

- A PHP port can be found [here](https://github.com/Arcesilas/md-word-count), with thanks to [@Arcesilas](https://github.com/Arcesilas)!
