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
RECURSE
Adding the –recurse flag will recursively load all subs underneath the named dynamic namespace (in the first positional arugment)
pop-tree exec --recurse
ADD_SUB
Every positional argument after –add-sub will be added as a dyne_name to the hub
Example
pop-tree --add-sub idem grains
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.
Project details
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-6.2.tar.gz
.
File metadata
- Download URL: pop-tree-6.2.tar.gz
- Upload date:
- Size: 10.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.0 importlib_metadata/3.7.2 packaging/20.9 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.9.2
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 262d18361f85e73add9a43ce7b902bc5338962898ed0fccd6fbeb0775d33f248 |
|
MD5 | a348bf98a256569f441065e6e971be79 |
|
BLAKE2b-256 | 988b1cb91e36af8ed35febed95bb967583d274462ccb351301c33b03b9a9795c |
File details
Details for the file pop_tree-6.2-py3-none-any.whl
.
File metadata
- Download URL: pop_tree-6.2-py3-none-any.whl
- Upload date:
- Size: 11.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.0 importlib_metadata/3.7.2 packaging/20.9 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.9.2
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4d4df4164caa48c2764efeb1d15ea23baf8e9a9092451cd43d31c0a2b08b910d |
|
MD5 | fc6583f5e48b10af89dad7d17b8dee83 |
|
BLAKE2b-256 | ae481dbeb122a319bd880ad37517936ca2b37f9ce476167e4060a0984eda30a1 |