https://github.com/iampukar/npm_analyser

A Python library to monitor an npm package!
https://github.com/iampukar/npm_analyser

npm- npm-statistics npm-stats npmjs pip-package

Last synced: 21 days ago
JSON representation

A Python library to monitor an npm package!

• Host: GitHub
• URL: https://github.com/iampukar/npm_analyser
• Owner: iampukar
• License: mit
• Created: 2022-03-30T13:34:24.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-03-30T15:06:13.000Z (over 2 years ago)
• Last Synced: 2024-11-16T14:19:16.685Z (about 1 month ago)
• Topics: npm-, npm-statistics, npm-stats, npmjs, pip-package
• Language: Python
• Homepage: https://pypi.org/project/npm-analyser/1.0.0/
• Size: 5.86 KB
• Stars: 2
• Watchers: 3
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Overview

-----------------------------------------------------------------------------

npm_analyser is a Python library to monitor an npm package! 

## Package Installer 

    pip install npm-analyser==1.0.0

## Usage

    from npm_analyser import npm_analyser

    '''

      package_name -> string npm package name.

    '''

    package_details = npm_analyser(package_name)

    

    print(package_details.package_name)

    print(package_details.version)

    print(package_details.weekly_downloads)

    print(package_details.license)

    print(package_details.last_published)

    print(package_details.get_dev_dependencies)

    

**Utilities**

| Name           | Description  |

| ------------- | -----|

| package_name | Returns the npm package name! |

| version | Returns the npm package version! |

| last_published | Returns the npm package last published date! |

| total_versions | Returns the total versions of npm package! |

| number_of_dependents | Returns the total number of dependents of the npm package! |

| get_dev_dependencies | Returns the dev-dependencies of the npm package! |

| weekly_downloads | Returns the weekly downloads of the npm package! |

| license | Returns the license of the npm package! |

| unpacked_size | Returns the unpacked size of the npm package! |

| total_files | Returns the total files of the npm package! |

## Requirements

The `requirements.txt` file has details of all Python libraries for this package, and can be installed using 

```

pip install -r requirements.txt

```

## Organization

    ├── src

    │   ├── npm_analyser

              ├── init             <- init

              ├── npm_analyser     <- package source code for npm analyser

    ├── setup.py             <- setup file 

    ├── LICENSE              <- LICENSE

    ├── README.md            <- README

    ├── CONTRIBUTING.md      <- contribution

    ├── test.py              <- test cases for unit testing

    ├── requirements.txt     <- requirements file for reproducing the code package

## License

MIT

## Contributions

For steps on code contribution, please see [CONTRIBUTING](./CONTRIBUTING.md).