Metadata-Version: 2.4
Name: npmstat
Version: 0.0.5
Summary: Get NPM Package Stats and Info from the command line or as a Python module.
Project-URL: Changelog, https://github.com/cssnr/npmstat/releases
Project-URL: Discord, https://discord.gg/wXy6m2X8wY
Project-URL: Documentation, https://cssnr.github.io/npmstat/
Project-URL: Funding, https://ko-fi.com/cssnr
Project-URL: GitHub, https://github.com/cssnr/npmstat
Project-URL: Homepage, https://cssnr.com/
Project-URL: Issues, https://github.com/cssnr/npmstat/issues
Author: Shane
License: MIT License
License-File: LICENSE
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Typing :: Typed
Requires-Python: >=3.10
Requires-Dist: argcomplete<4,>=3
Requires-Dist: requests-cache<2,>=1
Requires-Dist: requests<3,>=2
Description-Content-Type: text/markdown

[![PyPI Version](https://img.shields.io/pypi/v/npmstat?logo=pypi&logoColor=white&label=pypi)](https://pypi.org/project/npmstat/)
[![GitHub Release Version](https://img.shields.io/github/v/release/cssnr/npmstat?logo=github)](https://github.com/cssnr/npmstat/releases)
[![TOML Python Version](https://img.shields.io/badge/dynamic/toml?url=https%3A%2F%2Fraw.githubusercontent.com%2Fcssnr%2Fnpmstat%2Frefs%2Fheads%2Fmaster%2Fpyproject.toml&query=%24.project.requires-python&logo=python&logoColor=white&label=python)](https://github.com/cssnr/npmstat?tab=readme-ov-file#readme)
[![PyPI Downloads](https://img.shields.io/pypi/dm/npmstat?logo=pypi&logoColor=white)](https://pypistats.org/packages/npmstat)
[![Pepy Total Downloads](https://img.shields.io/pepy/dt/npmstat?logo=pypi&logoColor=white&label=total)](https://clickpy.clickhouse.com/dashboard/npmstat)
[![Codecov](https://codecov.io/gh/cssnr/npmstat/graph/badge.svg?token=A8NDHZ393X)](https://codecov.io/gh/cssnr/npmstat)
[![Workflow Lint](https://img.shields.io/github/actions/workflow/status/cssnr/npmstat/lint.yaml?logo=cachet&label=lint)](https://github.com/cssnr/npmstat/actions/workflows/lint.yaml)
[![Workflow Test](https://img.shields.io/github/actions/workflow/status/cssnr/npmstat/test.yaml?logo=cachet&label=test)](https://github.com/cssnr/npmstat/actions/workflows/test.yaml)
[![Deployment PyPi](https://img.shields.io/github/deployments/cssnr/npmstat/pypi?logo=pypi&logoColor=white&label=pypi)](https://pypi.org/project/npmstat/)
[![Deployment Docs](https://img.shields.io/github/deployments/cssnr/npmstat/docs?logo=materialformkdocs&logoColor=white&label=docs)](https://cssnr.github.io/npmstat/)
[![GitHub Last Commit](https://img.shields.io/github/last-commit/cssnr/npmstat?logo=github&label=updated)](https://github.com/cssnr/npmstat/pulse)
[![GitHub Repo Size](https://img.shields.io/github/repo-size/cssnr/npmstat?logo=bookstack&logoColor=white&label=repo%20size)](https://github.com/cssnr/npmstat)
[![GitHub Top Language](https://img.shields.io/github/languages/top/cssnr/npmstat?logo=htmx&logoColor=white)](https://github.com/cssnr/npmstat?tab=readme-ov-file#readme)
[![GitHub Contributors](https://img.shields.io/github/contributors-anon/cssnr/npmstat?logo=github)](https://github.com/cssnr/npmstat/graphs/contributors)
[![GitHub Issues](https://img.shields.io/github/issues/cssnr/npmstat?logo=github)](https://github.com/cssnr/npmstat/issues)
[![GitHub Discussions](https://img.shields.io/github/discussions/cssnr/npmstat?logo=github)](https://github.com/cssnr/npmstat/discussions)
[![GitHub Forks](https://img.shields.io/github/forks/cssnr/npmstat?style=flat&logo=github)](https://github.com/cssnr/npmstat/forks)
[![GitHub Repo Stars](https://img.shields.io/github/stars/cssnr/npmstat?style=flat&logo=github)](https://github.com/cssnr/npmstat/stargazers)
[![GitHub Org Stars](https://img.shields.io/github/stars/cssnr?style=flat&logo=github&label=org%20stars)](https://cssnr.github.io/)
[![Discord](https://img.shields.io/discord/899171661457293343?logo=discord&logoColor=white&label=discord&color=7289da)](https://discord.gg/wXy6m2X8wY)
[![Ko-fi](https://img.shields.io/badge/Ko--fi-72a5f2?logo=kofi&label=support)](https://ko-fi.com/cssnr)

# NPM Stat

<a title="NPM Stat" href="https://cssnr.github.io/npmstat/" target="_blank">
<img alt="NPM Stat" align="right" width="128" height="auto" src="https://cssnr.github.io/npmstat/assets/images/logo.svg"></a>

- [Install](#install)
- [Usage](#usage)
- [Support](#support)
- [Contributing](#contributing)

Get NPM Package Stats and Info from the command line or as a Python module.

## Install<a id="install"></a>

Install From PyPI: <https://pypi.org/p/npmstat>

```shell
python -m pip install npmstat
```

Get Package Stats.

```shell
npmstat stats @cssnr/vitepress-swiper
```

[![View Documentation](https://img.shields.io/badge/view_documentation-blue?style=for-the-badge&logo=googledocs&logoColor=white)](https://cssnr.github.io/npmstat/)

## Usage<a id="usage"></a>

To use run `npmstat` from your command line.

```text
usage: npmstat [-h] [-C] [-V] [command] ...

example: npmstat stats @cssnr/vitepress-swiper

positional arguments:
  [command]
    info             get package info
    stats            get download stats

options:
  -h, --help         show this help message and exit
  -C, --clear-cache  clear the request cache and exit
  -V, --version      show the package version and exit
```

[![View Documentation](https://img.shields.io/badge/view_documentation-blue?style=for-the-badge&logo=googledocs&logoColor=white)](https://cssnr.github.io/npmstat/)

## Support<a id="support"></a>

For general help or to request a feature, see:

- Q&A Discussion: <https://github.com/cssnr/npmstat/discussions/categories/q-a>
- Request a Feature: <https://github.com/cssnr/npmstat/discussions/categories/feature-requests>
- Chat with us on Discord: <https://discord.gg/wXy6m2X8wY>

If you are experiencing an issue/bug or getting unexpected results, you can:

- Report an Issue: <https://github.com/cssnr/npmstat/issues>
- Provide General Feedback: [https://cssnr.github.io/feedback/](https://cssnr.github.io/feedback/?app=npmstat)
- Chat with us on Discord: <https://discord.gg/wXy6m2X8wY>

## Contributing<a id="contributing"></a>

Contributing and Development docs are in the [CONTRIBUTING.md](#contributing-ov-file).

Please consider making a donation to support the development of this project
and [additional](https://cssnr.com/) open source projects.

[![Ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/cssnr)
