Skip to main content

Visualize POP hub/sub structures

Project description

POP hub and sub visualization tool

INSTALLATION

Bare installation with no dependencies

pip install pop-tree

Installation for pretty yaml output

pip install pop-tree\[rend\]

Installation for incredible graphs

pip install pop-tree\[networkx\]

Install everything

pip install pop-tree\[full\]

INSTALLATION FOR DEVELOPMENT

Clone the pop-tree repo and install with pip

git clone https://gitlab.com/Akm0d/pop-tree.git
pip install -e pop-tree\[full\]

Pop-doc

Another cli tool that comes with pop-tree is pop-doc. You can use this to grab the documentation for specific references on the hub.

pop-doc tree.init.refs

output:

ref:
    tree.init.refs
doc:
    Return all the references available on the hub by reference first
contracts:
    pre:
    call:
    post:
parameters:
    hub:
    tree:

        annotation:
            typing.Dict[str, typing.Any]

return_annotation:

EXECUTION

After installation the pop-tree command should now be available.

Running pop-tree by itself will only show things that the pop-tree project added to the hub. Naming a dynamic namespace will add it’s dyne_name to the hub and show only that namespace

pop-tree exec

OUTPUT

If you installed pop-tree with the [rend] extras, then –output can be used to specify an outputter from the rend project To see which outputters are available, just run

pop-tree output

Which will dynamically load the output dynamic namespace from the rend project and print the subs loaded immediately beneath it.

pop-tree --output nested

GRAPH

There are many different graphing plugins, some print to the terminal, and some open a shiny graph in a new window. To list the available graphing plugins, run

pop-tree graph

A graph plugin can be specified with the –graph option.

pop-tree --graph networkx

Which should print off a beautiful matplotlib plot to visualize your pop ecosystem. Use these arguments together to create impressive visuals for your project.

hub.png

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pop-tree-9.0.0.tar.gz (10.0 kB view details)

Uploaded Source

Built Distribution

pop_tree-9.0.0-py3-none-any.whl (12.2 kB view details)

Uploaded Python 3

File details

Details for the file pop-tree-9.0.0.tar.gz.

File metadata

  • Download URL: pop-tree-9.0.0.tar.gz
  • Upload date:
  • Size: 10.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.5.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.0 CPython/3.7.10

File hashes

Hashes for pop-tree-9.0.0.tar.gz
Algorithm Hash digest
SHA256 d3a1130ba805262c74a46bde5ccd942a1f46d6a68106e553adcfd3988efced00
MD5 3100d78c2856b02c35b58671b15d818d
BLAKE2b-256 9ccd6a9e00423960deb632d523cbb0dcc9b9738037a4ff9a2b18987d022cada8

See more details on using hashes here.

File details

Details for the file pop_tree-9.0.0-py3-none-any.whl.

File metadata

  • Download URL: pop_tree-9.0.0-py3-none-any.whl
  • Upload date:
  • Size: 12.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.5.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.0 CPython/3.7.10

File hashes

Hashes for pop_tree-9.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 794d9f5896c662d8617a08d3d18a9e1059013b1218fb3e1c36493275f92d20a2
MD5 9fbad189d0b8fc01e9cfa7eded513501
BLAKE2b-256 ae3c1dc9eb129fa6919aefe1cf2c4d5fa2ff0a61a88ae7687668688a8e08832f

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page