Skip to content

Glazing v0.1.1

Choose a tag to compare

@aaronstevenwhite aaronstevenwhite released this 27 Sep 23:57
bad03af

This patch release fixes a critical usability issue with CLI search commands and includes documentation improvements.

🐛 What's Fixed

CLI Commands Now Work As Documented

The search commands now work without requiring the --data-dir argument, matching the examples in our documentation.

Before v0.1.1:

$ glazing search query "abandon"
Error: Missing option '--data-dir'.

After v0.1.1:

$ glazing search query "abandon"
                          Search Results for 'abandon'                          
┏━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━┓
┃ Dataset  ┃ Type     ┃ ID/Name    ┃ Description                       ┃ Score ┃
┡━━━━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━┩
│ VERBNET  │ class    │ leave-51.2 │ VerbNet class with 1 members      │ 1.00  │
│ PROPBANK │ frameset │ abandon    │ PropBank frameset with 3 rolesets │ 1.00  │
└──────────┴──────────┴────────────┴───────────────────────────────────┴───────┘

Affected Commands

All search commands now automatically use the default data directory (~/.local/share/glazing/converted/):

  • glazing search query - Search across datasets
  • glazing search entity - Get entity details
  • glazing search role - Search for semantic roles
  • glazing search cross-ref - Find cross-references

📝 Documentation Improvements

This release incorporates the documentation improvements that were merged after v0.1.0:

  • More concise and natural language throughout documentation
  • Removed unnecessary promotional language
  • Improved docstring clarity
  • 50% reduction in documentation size while maintaining all essential information

📦 Updating

To get the latest version:

pip install --upgrade glazing

Requirements remain unchanged:

  • Python 3.13 or higher
  • ~5MB for the package
  • ~54MB for raw downloaded datasets
  • ~130MB total disk space after conversion

🔧 Technical Notes

  • Search commands now use get_default_data_path() from the glazing.initialize module
  • Default path respects XDG Base Directory specification ($XDG_DATA_HOME if set)
  • Commands with explicit --data-dir arguments continue to work as before
  • No breaking changes - fully backward compatible

📜 Citation

If you use Glazing in your research, please cite:

@software{glazing2025,
  author = {White, Aaron Steven},
  title = {Glazing: Unified Data Models and Interfaces for Syntactic and Semantic Frame Ontologies},
  year = {2025},
  url = {https://github.com/aaronstevenwhite/glazing},
  version = {0.1.1}
}

🙏 Acknowledgments

This project is funded by the National Science Foundation (BCS-2040831).

📮 Contact


For the complete changelog, see CHANGELOG.md