| Name | pip-viz JSON |
| Version |
0.0.6
JSON |
| download |
| home_page | None |
| Summary | A package that generates a graph of dependencies using Graphviz |
| upload_time | 2024-12-21 08:36:39 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | MIT License Copyright (c) 2024 John Cassidy 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. |
| keywords |
dependencies
graph
graphviz
pip
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
graphviz
pytest
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# pip-viz
A script that generates an SVG image displaying the dependencies within a pip
virtual environment.
## Installation
`pip-viz` uses `graphviz` Python library to generate
a `.gv` file containing instructions written in [Graphviz](https://graphviz.org)'s
DOT language. The Graphviz application takes the instructions written in the
`.gv` file and generates an image.
The [Graphviz](https://graphviz.org) application will need to be installed
separately. Linux, Windows, and Mac versions are available and the graphviz
executable `dot` will need to be on your `PATH`.
With your virtualenv active, install from the Python Package Index (PyPI)
with the following command:
`pip install pip-viz`
Once installed, use the `pip-viz` executable to render a diagram for the
current virtualenv. The syntax for this command is:
`pip-viz my_app_dependencies`
This command will generate two files in the current working directory:
- `my_app_dependencies.gv` - The file that defines the graph in the DOT language
- `my_app_dependencies.gv.svg` - An SVG image that you can view in your web
browser. You can use the zoom, scroll, and find features of your browser to
navigate the diagram.
## Changelog
### 0.0.6
- fixed project.scripts so package can be run using 'pip-viz'
### 0.0.5
- Refactored, added version numbers for packages.
- Added logging
- Created some tests
### 0.0.4
- Made this package pip installable
### 0.0.3
- Added graph attributes to make graph easier to read
### 0.0.2
- Fixed problem with duplicate notes
### 0.0.1
- Initial version
Raw data
{
"_id": null,
"home_page": null,
"name": "pip-viz",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "John Cassidy <jocassid@gmail.com>",
"keywords": "dependencies, graph, graphviz, pip",
"author": null,
"author_email": "John Cassidy <jocassid@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/c6/30/2c304d8352a830e467e63c7ca4c172f66570b7958091286b3fa9cfb14c30/pip_viz-0.0.6.tar.gz",
"platform": null,
"description": "\n# pip-viz\n\nA script that generates an SVG image displaying the dependencies within a pip \nvirtual environment.\n\n## Installation\n\n`pip-viz` uses `graphviz` Python library to generate \na `.gv` file containing instructions written in [Graphviz](https://graphviz.org)'s\nDOT language. The Graphviz application takes the instructions written in the\n`.gv` file and generates an image. \n\nThe [Graphviz](https://graphviz.org) application will need to be installed\nseparately. Linux, Windows, and Mac versions are available and the graphviz\nexecutable `dot` will need to be on your `PATH`.\n\nWith your virtualenv active, install from the Python Package Index (PyPI) \nwith the following command:\n\n`pip install pip-viz`\n\nOnce installed, use the `pip-viz` executable to render a diagram for the \ncurrent virtualenv. The syntax for this command is:\n\n`pip-viz my_app_dependencies`\n\nThis command will generate two files in the current working directory:\n\n- `my_app_dependencies.gv` - The file that defines the graph in the DOT language\n- `my_app_dependencies.gv.svg` - An SVG image that you can view in your web \nbrowser. You can use the zoom, scroll, and find features of your browser to \nnavigate the diagram.\n\n## Changelog\n\n### 0.0.6\n\n- fixed project.scripts so package can be run using 'pip-viz'\n\n### 0.0.5\n\n- Refactored, added version numbers for packages.\n- Added logging\n- Created some tests\n\n### 0.0.4\n\n- Made this package pip installable\n\n### 0.0.3\n\n- Added graph attributes to make graph easier to read\n\n### 0.0.2\n\n- Fixed problem with duplicate notes\n\n### 0.0.1\n\n- Initial version",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2024 John Cassidy 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.",
"summary": "A package that generates a graph of dependencies using Graphviz",
"version": "0.0.6",
"project_urls": {
"Changelog": "https://github.com/jocassid/pip-viz/blob/main/README.md",
"Documentation": "https://github.com/jocassid/pip-viz/blob/main/README.md",
"Homepage": "https://github.com/jocassid/pip-viz",
"Issues": "https://github.com/jocassid/pip-viz/issues",
"Repository": "https://github.com/jocassid/pip-viz.git"
},
"split_keywords": [
"dependencies",
" graph",
" graphviz",
" pip"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "230dc9020d014c7dbb72761c693c6fa9a3acc8f8dd9a95e9b73d72c6928b5523",
"md5": "222d4adf589c819a645161e4b8cdd08b",
"sha256": "224b825b01437bff640a34bcf4135b34847ede236b985b0564cb3b92af9cab64"
},
"downloads": -1,
"filename": "pip_viz-0.0.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "222d4adf589c819a645161e4b8cdd08b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 5399,
"upload_time": "2024-12-21T08:36:37",
"upload_time_iso_8601": "2024-12-21T08:36:37.302443Z",
"url": "https://files.pythonhosted.org/packages/23/0d/c9020d014c7dbb72761c693c6fa9a3acc8f8dd9a95e9b73d72c6928b5523/pip_viz-0.0.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c6302c304d8352a830e467e63c7ca4c172f66570b7958091286b3fa9cfb14c30",
"md5": "45e1c8b05e6110757545d066a720734f",
"sha256": "ffa44e961ff4ec31b8cb12e3a546c2d074d03afef4f7bce74452e29348850b13"
},
"downloads": -1,
"filename": "pip_viz-0.0.6.tar.gz",
"has_sig": false,
"md5_digest": "45e1c8b05e6110757545d066a720734f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 4976,
"upload_time": "2024-12-21T08:36:39",
"upload_time_iso_8601": "2024-12-21T08:36:39.352469Z",
"url": "https://files.pythonhosted.org/packages/c6/30/2c304d8352a830e467e63c7ca4c172f66570b7958091286b3fa9cfb14c30/pip_viz-0.0.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-21 08:36:39",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "jocassid",
"github_project": "pip-viz",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "graphviz",
"specs": [
[
"==",
"0.20.3"
]
]
},
{
"name": "pytest",
"specs": []
}
],
"lcname": "pip-viz"
}
