pop-tree 10.1.0

Visualize POP hub/sub structures

POP structure visualization tool

About

Visualize POP hub/sub structures with pop-tree, and view embedded rst content with pop-doc.

• pop-tree source code

• pop-tree documentation

What is POP?

This project is built with pop, a Python-based implementation of Plugin Oriented Programming (POP). POP seeks to bring together concepts and wisdom from the history of computing in new ways to solve modern computing problems.

For more information:

• Intro to Plugin Oriented Programming (POP)

• pop-awesome

• pop-create

Getting Started

Prerequisites

• Python 3.7+

• git (if installing from source, or contributing to the project)

Installation

Note

If wanting to contribute to the project, and setup your local development environment, see the CONTRIBUTING.rst document in the source repository for this project.

If wanting to use pop-tree, you can do so by either installing from PyPI or from source.

Install from PyPI

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\]

Install from source

# clone repo
git clone git@<your-project-path>/pop-tree.git
cd pop-tree

# Setup venv
python3 -m venv .venv
source .venv/bin/activate
pip install -e .\[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 also be available. Pop tree will add all dynamic namespaces in your current python environment to the hub.

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.

Roadmap

Reference the open issues for a list of proposed features (and known issues).

Acknowledgements

• Img Shields for making repository badges easy.