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.dev4.tar.gz (339.6 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.dev4-py3-none-any.whl (7.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: pio_env_graph-0.1.1.dev4.tar.gz
  • Upload date:
  • Size: 339.6 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.dev4.tar.gz
Algorithm Hash digest
SHA256 57d21b2f60e59002962ac3b767c98a6b64a71a0f776b6b18f0be1c3162438db3
MD5 f98e8bd67a18979ebdf8ebe9fa6dabb0
BLAKE2b-256 e3aafa516a109e1272a689e9c8dd06fc259e056e4ba9d276caef8e620005611f

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for pio_env_graph-0.1.1.dev4-py3-none-any.whl
Algorithm Hash digest
SHA256 f65ba34e9f5b79e786b6295b53043cd6353f4f697e1250a5f0a2f9fb4a2b5096
MD5 142dc76de6c3bf634256f4dd50e26427
BLAKE2b-256 4fae15c399bf420fbf01cdd458fa720df3cb727ecf4395573652af327d91297b

See more details on using hashes here.

Provenance

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