Metadata-Version: 2.4
Name: pelican-stat
Version: 0.3.2
Summary: cli tool for generating pelican article statistics
Project-URL: Documentation, https://github.com/Lee-W/pelican_stat/blob/docs/README.md
Project-URL: Repository, https://github.com/Lee-W/pelican_stat
Project-URL: Issues, https://github.com/Lee-W/pelican_stat/issues
Project-URL: Changelog, https://github.com/Lee-W/pelican_stat/blob/main/CHANGELOG.md
Author-email: Wei Lee <weilee.rx@gmail.com>
License: MIT License
        
        Copyright (c) 2025, Wei Lee
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
License-File: LICENSE
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
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
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: Implementation :: CPython
Requires-Python: <4.0,>=3.9
Requires-Dist: click>=8.1.8
Requires-Dist: pandas>=2.2.3
Requires-Dist: pelican[markdown]>=4.11.0
Requires-Dist: plotly>=6.0.0
Description-Content-Type: text/markdown

[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)
[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg?style=flat-square)](https://conventionalcommits.org)
[![GitHub Actions](https://github.com/Lee-W/pelican-stat/actions/workflows/python-check.yaml/badge.svg)](https://github.com/Lee-W/pelican-stat/actions/workflows/python-check.yaml)
[![PyPI Package latest release](https://img.shields.io/pypi/v/pelican_stat.svg?style=flat-square)](https://pypi.org/project/pelican_stat/)
[![PyPI Package download count (per month)](https://img.shields.io/pypi/dm/pelican_stat?style=flat-square)](https://pypi.org/project/pelican_stat/)
[![Supported versions](https://img.shields.io/pypi/pyversions/pelican-stat.svg?style=flat-square)](https://pypi.org/project/pelican_stat/)

# pelican_stat

CLI tool for generating pelican article statistics

## Getting Started

### Prerequisites

* [uv tool]

[uv tool]: https://docs.astral.sh/uv/concepts/tools/

## Usage

For installing this tool, I suggest using [uv tool], pipx or something similar.

```sh
uv tool install pelican_stat
```

After installation, you can see the detail by add `--help` flag.

e.g.,

```sh
pelican-stat --help
```

or

```sh
pelican-stat collect --help
```

or

```sh
pelican-stat plot --help
```

## Contributing

See [Contributing](contributing.md)

## Authors

Wei Lee <weilee.rx@gmail.com>

Created from [Lee-W/cookiecutter-python-template] version 3.0.0

[Lee-W/cookiecutter-python-template]: https://github.com/Lee-W/cookiecutter-python-template/tree/3.0.0
