Skip to content

v0.1.0

Choose a tag to compare

View all tags
@abdrysdale abdrysdale released this 20 Aug 14:01
· 93 commits to main since this release
v0.1.0
c200c18

🚀 Initial Release

We're excited to announce the first release of maude-cli, a command-line interface for searching the MAUDE (Manufacturer and User Facility Device Experience) database through the openFDA API. This tool brings medical device adverse event reporting data directly to your terminal.

✨ Key Features

  • Powerful search capabilities with flexible query logic:

    • Search term groups that support AND/OR logic (terms within groups are OR'd, groups are AND'd)
    • Sophisticated exclusion filtering to remove unwanted results
    • Field-specific searching (default: mdr_text.text)

  • Multiple output formats:

    • Org-mode (default) - perfect for note-taking and task management
    • JSON - for programmatic processing
    • CSV - for spreadsheet analysis
    • Plain text - for quick terminal viewing

  • Pagination control:

    • Set maximum pages to retrieve
    • Configure results per page
    • Automatic handling of API pagination

  • Field filtering:

    • Select specific fields to include in output
    • Customize which field to use as the item name

📦 Installation

  • Using uv (recommended)
uvx maude-cli
  • Or with pip
pip install maude-cli

🚦 Basic Usage

Search for reports containing either "MRI" or "MAGNET" AND either "STAPES" or "TYMP":

maude-cli "MRI,MAGNET" "STAPES,TYMP"

Search with specific fields and output format:

maude-cli "pacemaker" -f device.device_name -o json -F device.brand_name,patient.age

Search with exclusion criteria (find MRI reports but exclude artifacts):

maude-cli "MRI,MAGNET" -x "ARTIFACT,SHADOW"

📝 Advanced Examples

Multi-group exclusion (find pacemaker reports but exclude both battery AND lead issues):

maude-cli "pacemaker" -x "BATTERY,POWER" "LEAD,WIRE"

Field-specific search with CSV output:

maude-cli "defibrillator" -f device.device_name -o csv -F report_number,device.brand_name,patient.age

Complex scenario (search for infusion pump issues while excluding multiple categories):

maude-cli "infusion,pump" -x "SOFTWARE,ALGORITHM" "BAXTER" "NO_INJURY,NONE"

⚠️ Known Limitations

  • This tool depends on the openFDA API, which has rate limits
  • Some complex MAUDE data structures may not render perfectly in all output formats
  • The initial release focuses on core functionality; additional features will come in future releases

🤝 Contributing

We welcome contributions! If you'd like to help improve maude-cli, please check out our GitHub repository and open an issue or pull request.

This first release lays the foundation for accessing medical device safety data from the command line. We hope it helps researchers, healthcare professionals, and regulators work more efficiently with MAUDE data!

View on GitHub | Documentation

Full Changelog: https://github.com/sbu-physics-mri/maude-cli/commits/v0.1.0

Assets 4
Loading
0 Join discussion