https://github.com/veghdev/write-npmstat

write-npmstat makes it easy to collect, filter and save npm statistics to csv files.
https://github.com/veghdev/write-npmstat

Last synced: about 2 months ago
JSON representation

write-npmstat makes it easy to collect, filter and save npm statistics to csv files.

• Host: GitHub
• URL: https://github.com/veghdev/write-npmstat
• Owner: veghdev
• License: apache-2.0
• Created: 2022-04-27T07:18:04.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-09-26T07:40:44.000Z (over 2 years ago)
• Last Synced: 2024-10-12T15:10:44.593Z (3 months ago)
• Language: JavaScript
• Size: 414 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
[![npm version](https://badge.fury.io/js/write-npmstat.svg)](https://badge.fury.io/js/write-npmstat)

[![CI](https://github.com/veghdev/write-npmstat/workflows/CI/badge.svg?branch=main)](https://github.com/veghdev/write-npmstat/actions/workflows/ci.yml)

# About The Project

write-npmstat makes it easy to collect, filter and save npm statistics to csv files.

# Installation

write-npmstat requires `npm-stat-api`, `enum`, `csv-writer`, `csv-parser` and `node-fetch` packages.

```sh

npm install write-npmstat

```

# Usage

```js

const WriteNpmStat = require("write-npmstat").default;

const targetPackage = "npm-stat-api";

const csvDir = "stats/npm-stat-api";

const writenpmstat = new WriteNpmStat(targetPackage, csvDir);

writenpmstat.writeNpmStat("2021", "2022-03");

writenpmstat.datePeriod = "month";

writenpmstat.writeNpmStat("2022-01", "2022-04-15");

writenpmstat.writeLastWeekNpmStat();

```

Visit our [documentation](https://veghdev.github.io/write-npmstat/) site for code reference or 

our [wiki](https://github.com/veghdev/write-npmstat/wiki/) site for a step-by-step tutorial into write-npmstat.

# Contributing

We welcome contributions to the project, visit our [contributing](https://github.com/veghdev/write-npmstat/blob/main/CONTRIBUTING.md) guide for further info.

# Contact

Join our [discussions](https://github.com/veghdev/write-npmstat/discussions) page if you have any questions or comments.

# License

Copyright © 2022.

Released under the [Apache 2.0 License](https://github.com/veghdev/write-npmstat/blob/main/LICENSE).