npm-cockpit


Namenpm-cockpit JSON
Version 0.4.0 PyPI version JSON
download
home_page
SummaryInstallable command-line tool with web interface which helps to track nodejs project dependencies state
upload_time2023-04-23 22:06:02
maintainer
docs_urlNone
authorAlex Chirkin
requires_python>=3.7,<4.0
licenseMIT
keywords command dashboard npm statistic dependencies packages info
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # NPM-COCKPIT

A user-friendly application for JavaScript developers to visualize the dependency tree of NPM packages and NodeJS applications. 

Allows to get statistical info about application dependencies tree state. Provides an interface for filtering and viewing information through convenient tables and diagrams.

## Features

Visual representation of the entire dependency tree of a project. With ability to look all the paths for a specific package. Dependency tree can be visualized as a tree or directed network chart

![tree chart](https://chartexample.com/images/npm-cockpit/network.jpg)

Detailed information about each package, including version, description, and related links.

![packages list](https://chartexample.com/images/npm-cockpit/list.jpg)

Identify potential issues such as outdated, deprecated or vulnerable packages.

![packages list](https://chartexample.com/images/npm-cockpit/deprecated.jpg)

**AND MUCH MORE!**


## Requirements

### General
- Terminal or command prompt access
- Target application folder should contain node_modules folder with installed dependencies and package.json
- Node.js and NPM installed

### As NPM package
- `python` command should be available

## Usage

### Command params

`path` - a path to project folder with package.json and node_modules inside

`port` - available local port to serve the app (default `8080`)

### PIP
`pip install npm-cockpit`

`npm-cockpit [path] [port]`

### NPM globally installed
`npm install --global npm-cockpit`

`npm-cockpit [path] [port]`

### NPX
`npx npm-cockpit [path] [port]`

### NPM dependency in package
`npm install npm-cockpit` and add the run script in the package json with proper params

## Development
- `git clone https://github.com/b0000ring/npm-cockpit.git`
- `cd npm-cockpit`
- `node index.js [path] [port]` or `python __main__.py [path] [port]`

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "npm-cockpit",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.7,<4.0",
    "maintainer_email": "",
    "keywords": "command,dashboard,npm,statistic,dependencies,packages,info",
    "author": "Alex Chirkin",
    "author_email": "hello@alexchirkin.me",
    "download_url": "https://files.pythonhosted.org/packages/d9/67/f76b88f79517256dd1d50feafd19aed4b84cba93def06cba9e854634312b/npm-cockpit-0.4.0.tar.gz",
    "platform": null,
    "description": "# NPM-COCKPIT\n\nA user-friendly application for JavaScript developers to visualize the dependency tree of NPM packages and NodeJS applications. \n\nAllows to get statistical info about application dependencies tree state. Provides an interface for filtering and viewing information through convenient tables and diagrams.\n\n## Features\n\nVisual representation of the entire dependency tree of a project. With ability to look all the paths for a specific package. Dependency tree can be visualized as a tree or directed network chart\n\n![tree chart](https://chartexample.com/images/npm-cockpit/network.jpg)\n\nDetailed information about each package, including version, description, and related links.\n\n![packages list](https://chartexample.com/images/npm-cockpit/list.jpg)\n\nIdentify potential issues such as outdated, deprecated or vulnerable packages.\n\n![packages list](https://chartexample.com/images/npm-cockpit/deprecated.jpg)\n\n**AND MUCH MORE!**\n\n\n## Requirements\n\n### General\n- Terminal or command prompt access\n- Target application folder should contain node_modules folder with installed dependencies and package.json\n- Node.js and NPM installed\n\n### As NPM package\n- `python` command should be available\n\n## Usage\n\n### Command params\n\n`path` - a path to project folder with package.json and node_modules inside\n\n`port` - available local port to serve the app (default `8080`)\n\n### PIP\n`pip install npm-cockpit`\n\n`npm-cockpit [path] [port]`\n\n### NPM globally installed\n`npm install --global npm-cockpit`\n\n`npm-cockpit [path] [port]`\n\n### NPX\n`npx npm-cockpit [path] [port]`\n\n### NPM dependency in package\n`npm install npm-cockpit` and add the run script in the package json with proper params\n\n## Development\n- `git clone https://github.com/b0000ring/npm-cockpit.git`\n- `cd npm-cockpit`\n- `node index.js [path] [port]` or `python __main__.py [path] [port]`\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Installable command-line tool with web interface which helps to track nodejs project dependencies state",
    "version": "0.4.0",
    "split_keywords": [
        "command",
        "dashboard",
        "npm",
        "statistic",
        "dependencies",
        "packages",
        "info"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "1510929786f5168b3c60970908fcddfb62ef157dca3c9731188d09ac143dadb1",
                "md5": "a2729496ede3041204019773f09d9dcf",
                "sha256": "1c92ae2a1f57e92b70b241fb112ff91a0a2f46626505a57a34f9db86356e198d"
            },
            "downloads": -1,
            "filename": "npm_cockpit-0.4.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "a2729496ede3041204019773f09d9dcf",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7,<4.0",
            "size": 538109,
            "upload_time": "2023-04-23T22:06:06",
            "upload_time_iso_8601": "2023-04-23T22:06:06.945169Z",
            "url": "https://files.pythonhosted.org/packages/15/10/929786f5168b3c60970908fcddfb62ef157dca3c9731188d09ac143dadb1/npm_cockpit-0.4.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "d967f76b88f79517256dd1d50feafd19aed4b84cba93def06cba9e854634312b",
                "md5": "9b3d9aa6050be99e6b5de3b13b504038",
                "sha256": "3751d3ee9b51f9dc5e296434c040898044868d7ce84d89e8e8b3b2982b71d0f0"
            },
            "downloads": -1,
            "filename": "npm-cockpit-0.4.0.tar.gz",
            "has_sig": false,
            "md5_digest": "9b3d9aa6050be99e6b5de3b13b504038",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7,<4.0",
            "size": 513155,
            "upload_time": "2023-04-23T22:06:02",
            "upload_time_iso_8601": "2023-04-23T22:06:02.942828Z",
            "url": "https://files.pythonhosted.org/packages/d9/67/f76b88f79517256dd1d50feafd19aed4b84cba93def06cba9e854634312b/npm-cockpit-0.4.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-04-23 22:06:02",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "lcname": "npm-cockpit"
}
        
Elapsed time: 0.06127s