carport


Namecarport JSON
Version 0.1.1 PyPI version JSON
download
home_pagehttps://github.com/felidz/carport
SummaryDependency Graph from Python imports
upload_time2024-02-26 11:17:13
maintainer
docs_urlNone
authorfelidz
requires_python>=3.7
licenseApache Software License 2.0
keywords nbdev jupyter notebook python
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Carport


<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->

Dependen**c**y Gr**a**ph f**r**om **P**ython imp**ort**s (CARPORT).

<!-- [![PyPI Version](https://img.shields.io/pypi/v/certx.svg?style=flat-square&color=blue)](https://pypi.org/project/certx/) 
![GitHub License](https://img.shields.io/github/license/felidz/certx.svg?style=flat-square&logo=github) -->
<!-- ![GitHub Release](https://img.shields.io/github/v/release/felidz/certx.svg?style=flat-square&logo=github) -->
<!-- ![GitHub commit activity](https://img.shields.io/github/commit-activity/t/felidz/certx.svg?style=flat-square&logo=github)
![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/felidz/certx.svg?style=flat-square&logo=github)
![GitHub top language](https://img.shields.io/github/languages/top/felidz/certx.svg?style=flat-square) -->
<!-- 
![GitHub last commit](https://img.shields.io/github/last-commit/felidz/certx.svg?style=flat-square&logo=github&color=darkgreen) 
![GitHub Actions CI Workflow Status](https://img.shields.io/github/actions/workflow/status/felidz/certx/test.yaml?style=flat-square&logo=github&label=CI)
![GitHub Actions Docs Workflow Status](https://img.shields.io/github/actions/workflow/status/felidz/certx/deploy.yaml?style=flat-square&logo=github&label=docs)
![Codecov](https://img.shields.io/codecov/c/github/felidz/certx.svg?style=flat-square&logo=codecov)
![Scrutinizer quality](https://img.shields.io/scrutinizer/quality/g/felidz/certx.svg?style=flat-square&logo=Scrutinizer) -->
<!-- ![discord](https://img.shields.io/badge/Discord?style=flat-square&logo=discord&logoColor=white) -->

## Installation

``` sh
pip install carport
```

## Usage

``` python
# WIP
from carport.core import ImportGraph

depg = ImportGraph(root = '..', project='carport')
# vars(depg)
```

``` python
ignore_nodes = ['io', 'IPython', 'pprint', 'subprocess']
```

``` python
dot = depg.to_dot(ignore_nodes=ignore_nodes)
dot
```

    'digraph  {\n"carport.vis";\n"carport.core";\npathlib;\nnetworkx;\nast;\ngraphviz;\nkroki;\n"carport.vis" -> "carport.core"  [key=0];\npathlib -> "carport.core"  [key=0];\nnetworkx -> "carport.core"  [key=0];\nast -> "carport.core"  [key=0];\ngraphviz -> "carport.vis"  [key=0];\nkroki -> "carport.vis"  [key=0];\n}\n'

``` python
dotg = depg.draw_dot(ignore_nodes=ignore_nodes)
dotg
```

![](index_files/figure-commonmark/cell-5-output-1.svg)

``` python
d2 = depg.to_d2(ignore_nodes=ignore_nodes)
d2
```

    '\n        vars: { \n            d2-config: { \n                layout-engine: elk \n                } \n            }\n        direction: right\n        **.style.border-radius: 99\n        *.style.font: mono\n        \nsubprocess -> carport.vis\nIPython -> carport.vis\nast -> carport.core\npathlib -> carport.core\nnetworkx -> carport.core\nio -> carport.core\ngraphviz -> carport.vis\ncarport.vis -> carport.core\nkroki -> carport.vis\nio: null\nIPython: null\npprint: null\nsubprocess: null'

``` python
d2g = depg.draw_d2(ignore_nodes=ignore_nodes)
d2g
```

![](index_files/figure-commonmark/cell-7-output-1.svg)

TODOs:

\[\] imports concerning `__init__.py`

\[\] `py_d2` to d2 (like `graphviz` to graphviz)

## Related

import-deps: [Github](https://github.com/schettino72/import-deps)

pydeps: [Github](https://github.com/thebjorn/pydeps)

snakefood3: [Github](https://github.com/Trim21/snakefood3)

kroki: [online editor](https://kroki.io/),
[python-interface](https://github.com/thorwhalen/kroki)

D2: [doc](https://d2lang.com/tour/text), [online
editor](https://play.d2lang.com/),
[python-interface](https://github.com/MrBlenny/py-d2)

## Statistics

<!-- <img src="https://api.star-history.com/svg?repos=felidz/certx&type=Date" alt="drawing" width="390"/> -->

![GitHub Repo
stars](https://img.shields.io/github/stars/felidz/certx.svg?style=flat-square&logo=github)
![PyPI -
Downloads](https://img.shields.io/pypi/dm/certx.svg?style=flat-square&logo=pypi)
<!-- ![GitHub Downloads](https://img.shields.io/github/downloads/felidz/certx/total.svg?style=flat-square&logo=github) -->

## Copyright

Copyright © 2024 onward Felidz. All rights reserved, with certain parts
of the project specifically licensed and subject to different terms and
conditions, e.g., source code of the project under the Apache-2.0
license; you may not use this project except in compliance with the
license.

## Citation

BibTeX citation:

``` bibtex
@misc{felidz2024,
  author = {Felidz},
  title = {Carport},
  year = {2024},
  publisher = {GitHub},
  journal = {GitHub repository},
  howpublished = {\url{https://github.com/felidz/carport}}
}
```

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/felidz/carport",
    "name": "carport",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": "",
    "keywords": "nbdev jupyter notebook python",
    "author": "felidz",
    "author_email": "cofelidz@outlook.com",
    "download_url": "https://files.pythonhosted.org/packages/62/fe/f6cc404f997031e5e0c3688a4d8f02c19cc305663e490636114da330ced0/carport-0.1.1.tar.gz",
    "platform": null,
    "description": "# Carport\r\n\r\n\r\n<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->\r\n\r\nDependen**c**y Gr**a**ph f**r**om **P**ython imp**ort**s (CARPORT).\r\n\r\n<!-- [![PyPI Version](https://img.shields.io/pypi/v/certx.svg?style=flat-square&color=blue)](https://pypi.org/project/certx/) \r\n![GitHub License](https://img.shields.io/github/license/felidz/certx.svg?style=flat-square&logo=github) -->\r\n<!-- ![GitHub Release](https://img.shields.io/github/v/release/felidz/certx.svg?style=flat-square&logo=github) -->\r\n<!-- ![GitHub commit activity](https://img.shields.io/github/commit-activity/t/felidz/certx.svg?style=flat-square&logo=github)\r\n![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/felidz/certx.svg?style=flat-square&logo=github)\r\n![GitHub top language](https://img.shields.io/github/languages/top/felidz/certx.svg?style=flat-square) -->\r\n<!-- \r\n![GitHub last commit](https://img.shields.io/github/last-commit/felidz/certx.svg?style=flat-square&logo=github&color=darkgreen) \r\n![GitHub Actions CI Workflow Status](https://img.shields.io/github/actions/workflow/status/felidz/certx/test.yaml?style=flat-square&logo=github&label=CI)\r\n![GitHub Actions Docs Workflow Status](https://img.shields.io/github/actions/workflow/status/felidz/certx/deploy.yaml?style=flat-square&logo=github&label=docs)\r\n![Codecov](https://img.shields.io/codecov/c/github/felidz/certx.svg?style=flat-square&logo=codecov)\r\n![Scrutinizer quality](https://img.shields.io/scrutinizer/quality/g/felidz/certx.svg?style=flat-square&logo=Scrutinizer) -->\r\n<!-- ![discord](https://img.shields.io/badge/Discord?style=flat-square&logo=discord&logoColor=white) -->\r\n\r\n## Installation\r\n\r\n``` sh\r\npip install carport\r\n```\r\n\r\n## Usage\r\n\r\n``` python\r\n# WIP\r\nfrom carport.core import ImportGraph\r\n\r\ndepg = ImportGraph(root = '..', project='carport')\r\n# vars(depg)\r\n```\r\n\r\n``` python\r\nignore_nodes = ['io', 'IPython', 'pprint', 'subprocess']\r\n```\r\n\r\n``` python\r\ndot = depg.to_dot(ignore_nodes=ignore_nodes)\r\ndot\r\n```\r\n\r\n    'digraph  {\\n\"carport.vis\";\\n\"carport.core\";\\npathlib;\\nnetworkx;\\nast;\\ngraphviz;\\nkroki;\\n\"carport.vis\" -> \"carport.core\"  [key=0];\\npathlib -> \"carport.core\"  [key=0];\\nnetworkx -> \"carport.core\"  [key=0];\\nast -> \"carport.core\"  [key=0];\\ngraphviz -> \"carport.vis\"  [key=0];\\nkroki -> \"carport.vis\"  [key=0];\\n}\\n'\r\n\r\n``` python\r\ndotg = depg.draw_dot(ignore_nodes=ignore_nodes)\r\ndotg\r\n```\r\n\r\n![](index_files/figure-commonmark/cell-5-output-1.svg)\r\n\r\n``` python\r\nd2 = depg.to_d2(ignore_nodes=ignore_nodes)\r\nd2\r\n```\r\n\r\n    '\\n        vars: { \\n            d2-config: { \\n                layout-engine: elk \\n                } \\n            }\\n        direction: right\\n        **.style.border-radius: 99\\n        *.style.font: mono\\n        \\nsubprocess -> carport.vis\\nIPython -> carport.vis\\nast -> carport.core\\npathlib -> carport.core\\nnetworkx -> carport.core\\nio -> carport.core\\ngraphviz -> carport.vis\\ncarport.vis -> carport.core\\nkroki -> carport.vis\\nio: null\\nIPython: null\\npprint: null\\nsubprocess: null'\r\n\r\n``` python\r\nd2g = depg.draw_d2(ignore_nodes=ignore_nodes)\r\nd2g\r\n```\r\n\r\n![](index_files/figure-commonmark/cell-7-output-1.svg)\r\n\r\nTODOs:\r\n\r\n\\[\\] imports concerning `__init__.py`\r\n\r\n\\[\\] `py_d2` to d2 (like `graphviz` to graphviz)\r\n\r\n## Related\r\n\r\nimport-deps: [Github](https://github.com/schettino72/import-deps)\r\n\r\npydeps: [Github](https://github.com/thebjorn/pydeps)\r\n\r\nsnakefood3: [Github](https://github.com/Trim21/snakefood3)\r\n\r\nkroki: [online editor](https://kroki.io/),\r\n[python-interface](https://github.com/thorwhalen/kroki)\r\n\r\nD2: [doc](https://d2lang.com/tour/text), [online\r\neditor](https://play.d2lang.com/),\r\n[python-interface](https://github.com/MrBlenny/py-d2)\r\n\r\n## Statistics\r\n\r\n<!-- <img src=\"https://api.star-history.com/svg?repos=felidz/certx&type=Date\" alt=\"drawing\" width=\"390\"/> -->\r\n\r\n![GitHub Repo\r\nstars](https://img.shields.io/github/stars/felidz/certx.svg?style=flat-square&logo=github)\r\n![PyPI -\r\nDownloads](https://img.shields.io/pypi/dm/certx.svg?style=flat-square&logo=pypi)\r\n<!-- ![GitHub Downloads](https://img.shields.io/github/downloads/felidz/certx/total.svg?style=flat-square&logo=github) -->\r\n\r\n## Copyright\r\n\r\nCopyright \u00a9 2024 onward Felidz. All rights reserved, with certain parts\r\nof the project specifically licensed and subject to different terms and\r\nconditions, e.g., source code of the project under the Apache-2.0\r\nlicense; you may not use this project except in compliance with the\r\nlicense.\r\n\r\n## Citation\r\n\r\nBibTeX citation:\r\n\r\n``` bibtex\r\n@misc{felidz2024,\r\n  author = {Felidz},\r\n  title = {Carport},\r\n  year = {2024},\r\n  publisher = {GitHub},\r\n  journal = {GitHub repository},\r\n  howpublished = {\\url{https://github.com/felidz/carport}}\r\n}\r\n```\r\n",
    "bugtrack_url": null,
    "license": "Apache Software License 2.0",
    "summary": "Dependency Graph from Python imports",
    "version": "0.1.1",
    "project_urls": {
        "Homepage": "https://github.com/felidz/carport"
    },
    "split_keywords": [
        "nbdev",
        "jupyter",
        "notebook",
        "python"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "cea9705ad7e4e4e0e9ff776cb88e2cb897e2a4165cc252c8aedb50731d0050b0",
                "md5": "54c3d78dbee94163fa620d7337b9d519",
                "sha256": "9ce4f4da7803c0ad5b0293d66b4a7f3cf5de58455794fcd75717509283f8703a"
            },
            "downloads": -1,
            "filename": "carport-0.1.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "54c3d78dbee94163fa620d7337b9d519",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7",
            "size": 11015,
            "upload_time": "2024-02-26T11:17:11",
            "upload_time_iso_8601": "2024-02-26T11:17:11.555972Z",
            "url": "https://files.pythonhosted.org/packages/ce/a9/705ad7e4e4e0e9ff776cb88e2cb897e2a4165cc252c8aedb50731d0050b0/carport-0.1.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "62fef6cc404f997031e5e0c3688a4d8f02c19cc305663e490636114da330ced0",
                "md5": "498f24d9020e52b10607c19d3a515f83",
                "sha256": "22569d5ba701e7b000686837fb8c11c066d30f8bae9d10fc1467c6143d3cc861"
            },
            "downloads": -1,
            "filename": "carport-0.1.1.tar.gz",
            "has_sig": false,
            "md5_digest": "498f24d9020e52b10607c19d3a515f83",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 11679,
            "upload_time": "2024-02-26T11:17:13",
            "upload_time_iso_8601": "2024-02-26T11:17:13.636830Z",
            "url": "https://files.pythonhosted.org/packages/62/fe/f6cc404f997031e5e0c3688a4d8f02c19cc305663e490636114da330ced0/carport-0.1.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-02-26 11:17:13",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "felidz",
    "github_project": "carport",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "carport"
}
        
Elapsed time: 0.18251s