Skip to main content

pop-tree

Made with pop, a Python implementation of Plugin Oriented Programming Documentation is published with Sphinx on GitLab Pages via vmware.gitlab.io Made with Python

POP structure visualization tool

About

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

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:

Getting Started

Prerequisites

  • Python 3.8+

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

Installation

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.

hub.png

Roadmap

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

Acknowledgements

Metadata

Release files for pop-tree 12.1.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pop-tree 12.1.2
File Size Uploaded Provenance
pop-tree-12.1.2.tar.gz 19.1 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for pop-tree 12.1.2
File Interpreter ABI Platform
pop_tree-12.1.2-py3-none-any.whl Python 3 none any Details

Total release size: 39.8 kB

Release files / pop-tree-12.1.2.tar.gz

Download URL pop-tree-12.1.2.tar.gz
Size 19.1 kB
Tags Source
SHA-256 checksum
How to use checksums
77bda1f774cd7da526394c8467d21a9f3a1efdc8130da7117d71bf6d5651c577
BLAKE2b-256 checksum
How to use checksums
fa9cd37bf35600bd0f24a860cf65d399a9a1d946f9d0fdc9157b235540ba7786
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.8.0 pkginfo/1.9.6 readme-renderer/41.0 requests/2.31.0 requests-toolbelt/1.0.0 urllib3/2.0.5 tqdm/4.66.1 importlib-metadata/6.8.0 keyring/24.2.0 rfc3986/2.0.0 colorama/0.4.6 CPython/3.9.18

Release files / pop_tree-12.1.2-py3-none-any.whl

Download URL pop_tree-12.1.2-py3-none-any.whl
Size 20.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
8359addfec46dbe206a5f9e2d9f3729d0de0f36f830b8906ea3b8de064b29caa
BLAKE2b-256 checksum
How to use checksums
aed270fd2c5031430c3566447bf5798605ea1371047053ffd135f0e65469bed8
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.8.0 pkginfo/1.9.6 readme-renderer/41.0 requests/2.31.0 requests-toolbelt/1.0.0 urllib3/2.0.5 tqdm/4.66.1 importlib-metadata/6.8.0 keyring/24.2.0 rfc3986/2.0.0 colorama/0.4.6 CPython/3.9.18

Security for pop-tree 12.1.2

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page