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 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.0.tar.gz (9.8 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.0-py3-none-any.whl (7.4 kB view details)

Uploaded Python 3

File details

Details for the file pio_env_graph-0.1.0.tar.gz.

File metadata

  • Download URL: pio_env_graph-0.1.0.tar.gz
  • Upload date:
  • Size: 9.8 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.0.tar.gz
Algorithm Hash digest
SHA256 beccf69359c3fc804050b9a518639f294d42a433255535844372fab2a6720114
MD5 c5b4d118abc14f5fe036f45b937284b4
BLAKE2b-256 014d180c1516f06894b7d9d7c42ee8da23b6d64587338803ad267258d13da3ff

See more details on using hashes here.

Provenance

The following attestation bundles were made for pio_env_graph-0.1.0.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.0-py3-none-any.whl.

File metadata

  • Download URL: pio_env_graph-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 7.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for pio_env_graph-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 579dae8ef71414b2d422b0d9854be1dfa298579171e3e6d8bd6181e9cfd44235
MD5 fc174e9284351c4c3042873b19712613
BLAKE2b-256 deb5e2e9fda863ee5739fcf3f54c73c378e933195831083c56676e817fcd7cc8

See more details on using hashes here.

Provenance

The following attestation bundles were made for pio_env_graph-0.1.0-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