Skip to main content

Visualize PlatformIO environment dependency graph

Project description

pio-env-graph

⚠️ Early development — this project is in beta. The core functionality works but the API and CLI flags may change between releases. Feedback and bug reports are welcome.

Visualize extends dependencies between sections in platformio.ini as a Graphviz DOT graph.

Install

From PyPI (once published):

pip install pio-env-graph

From GitHub:

pip install git+https://github.com/eagafonov/pio-env-graph.git

From source:

pip install -e .

Usage

pio-env-graph                                          # auto-discovers ./platformio.ini
pio-env-graph /path/to/platformio.ini                  # explicit path
pio-env-graph -o graph.dot                             # write to file
pio-env-graph | dot -Tpng -o graph.png                 # render to PNG
pio-env-graph -d LR                                    # left-to-right (default: RL)
pio-env-graph --refs                                   # include ${section.key} references
pio-env-graph | dot -Tpng | display -                  # render and display immediately

Directions: RL (right-to-left, default), LR, TB, BT.

Examples

Default (RL)

default

Top to bottom

pio-env-graph -d TB

top-to-bottom

With ${section.key} references

pio-env-graph --refs

refs

Development

The Makefile handles venv setup automatically on first run:

make test               # run tests
make lint               # check formatting + lint
make format             # auto-format code

Or set up manually:

python3 -m venv .venv
source .venv/bin/activate
pip install -e .
pip install -r requirements-dev.txt

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

pio_env_graph-0.1.1.dev3.tar.gz (339.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pio_env_graph-0.1.1.dev3-py3-none-any.whl (7.5 kB view details)

Uploaded Python 3

File details

Details for the file pio_env_graph-0.1.1.dev3.tar.gz.

File metadata

  • Download URL: pio_env_graph-0.1.1.dev3.tar.gz
  • Upload date:
  • Size: 339.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for pio_env_graph-0.1.1.dev3.tar.gz
Algorithm Hash digest
SHA256 d69bbe7e50c81ea52d209b3e863f44ca4c5479a574a21dc87c29d631483ee104
MD5 570adadfac41ea993535a5855858feb5
BLAKE2b-256 c414db77f08d3487e61a380400e72ef82ea12b16d382fbb66a1ad460675c1361

See more details on using hashes here.

Provenance

The following attestation bundles were made for pio_env_graph-0.1.1.dev3.tar.gz:

Publisher: publish.yml on eagafonov/pio-env-graph

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file pio_env_graph-0.1.1.dev3-py3-none-any.whl.

File metadata

File hashes

Hashes for pio_env_graph-0.1.1.dev3-py3-none-any.whl
Algorithm Hash digest
SHA256 f9d0ae3d627cdf44bc0a505ba6406cf7aa17312bc87ff232f4dd8f701748a0e3
MD5 5b6d95e6377f2c3c6057bc6007316e09
BLAKE2b-256 2b068a552e5dbd1956138c02c75b29b010439d08f7a3fbd8f32260212c1009b2

See more details on using hashes here.

Provenance

The following attestation bundles were made for pio_env_graph-0.1.1.dev3-py3-none-any.whl:

Publisher: publish.yml on eagafonov/pio-env-graph

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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