Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

tools: rename GDB plugin to pynuttx/nxgdb and enable PyPI packaging #15740

Merged
merged 3 commits into from
Feb 2, 2025

Conversation

XuNeo
Copy link
Contributor

@XuNeo XuNeo commented Feb 1, 2025

Summary

Renames tools/gdb/nuttxgdbtools/pynuttx/nxgdb

Establishes pynuttx as the root directory for future Python package development

Prepares for publishing nxgdb as an installable package (pip install nxgdb)

Impact

Enables direct package import in GDB:

(gdb) py import nxgdb  # Instead of manual path sourcing

Simplifies dependency management via PyPI

The original method still works, allowing to import latest python script, making it easy during python script development.

(gdb) source /path/to/nuttx/tools/pynuttx/gdbinit.py

Future Work

Gradually migrate other Python utilities to pynuttx and publish pynuttx as a namespace package.

Testing

Test package already published on PyPI (nxgdb)

Verified working installation flow:

qemu + GDB, now we can use py import nxgdb and legacy source gdbinit.py

@github-actions github-actions bot added Area: Tooling Size: L The size of the change in this PR is large labels Feb 1, 2025
@nuttxpr
Copy link

nuttxpr commented Feb 1, 2025

[Experimental Bot, please feedback here]

Yes, this PR appears to meet the NuttX requirements. It provides a clear summary of the changes, their rationale, and their impact. The impact section addresses all relevant points, highlighting the benefits for users (easier import and dependency management) and acknowledging future development plans. Testing confirms functionality through both PyPI installation and the existing manual method. The provided links to the PyPI package and clear testing descriptions further strengthen the PR.

@xiaoxiang781216 xiaoxiang781216 merged commit 698b2e0 into apache:master Feb 2, 2025
39 checks passed
@XuNeo XuNeo deleted the rename-python-tools-pynuttx branch February 2, 2025 06:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area: Tooling Size: L The size of the change in this PR is large
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants