Visualize POP hub/sub structures
Project description
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.7+
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-treeInstallation 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.refsoutput:
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 execOUTPUT
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 outputWhich will dynamically load the output dynamic namespace from the rend project and print the subs loaded immediately beneath it.
pop-tree --output nestedGRAPH
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 graphA graph plugin can be specified with the –graph option.
pop-tree --graph networkxWhich 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.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file pop-tree-10.1.0.tar.gz.
File metadata
- Download URL: pop-tree-10.1.0.tar.gz
- Upload date:
- Size: 17.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.8.0 pkginfo/1.9.6 readme-renderer/37.3 requests/2.28.2 requests-toolbelt/0.10.1 urllib3/1.26.15 tqdm/4.65.0 importlib-metadata/6.1.0 keyring/23.13.1 rfc3986/2.0.0 colorama/0.4.6 CPython/3.9.16
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 22f4f28c29c2807bbf28becd6a3fb15e87136024923a48e85c9de857f1637c3a |
|
| MD5 | 15a03ca3f1dd51d8867dd6789fb7264a |
|
| BLAKE2b-256 | c85379ae03c58c5aa3393f179c81b8b92cc96cd77ddde00f9985fcb3c90cda2f |
File details
Details for the file pop_tree-10.1.0-py3-none-any.whl.
File metadata
- Download URL: pop_tree-10.1.0-py3-none-any.whl
- Upload date:
- Size: 19.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.8.0 pkginfo/1.9.6 readme-renderer/37.3 requests/2.28.2 requests-toolbelt/0.10.1 urllib3/1.26.15 tqdm/4.65.0 importlib-metadata/6.1.0 keyring/23.13.1 rfc3986/2.0.0 colorama/0.4.6 CPython/3.9.16
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 5b36fb3a1c2798ac0cd0ba849d1fca9c6e854359b3291aefb30a40fe3c2524bd |
|
| MD5 | 1dd4acbb6f6bdccba4d30596bcc912c4 |
|
| BLAKE2b-256 | 160090e05274656abc907913784c8ac5e8066f89a2f0566933a4d59b0f36a62a |
