Skip to content

Organize examples into folders and add PEP 723 metadata#33

Merged
nicosuave merged 1 commit intomainfrom
nicosuave/organize-examples
Jan 5, 2026
Merged

Organize examples into folders and add PEP 723 metadata#33
nicosuave merged 1 commit intomainfrom
nicosuave/organize-examples

Conversation

@nicosuave
Copy link
Copy Markdown
Member

Summary

Reorganizes 17 example files into logical folders (basic, sql, yaml, features, advanced, integrations, notebooks) and adds PEP 723 inline script metadata for remote execution with automatic dependency installation.

Changes

  • Moved example files into organized subdirectories by topic and complexity
  • Added PEP 723 metadata blocks to enable uv run <url> execution
  • Updated example run instructions to use raw GitHub URLs
  • Updated README with runnable examples and new folder structure
  • Updated Colab notebook links to new paths

Benefits

Users can now run examples directly without cloning: uv run https://raw.githubusercontent.com/sidequery/sidemantic/main/examples/sql/sql_syntax_example.py

Reorganizes 17 loose example files into logical folders:
- basic/: Getting started examples
- sql/: SQL query interface demonstrations
- yaml/: YAML syntax examples
- features/: Feature-specific demos (parameters, symmetric aggregates, multi-hop joins)
- advanced/: Comprehensive demos
- integrations/: Streamlit, charts, export adapters
- notebooks/: Jupyter notebooks

Adds PEP 723 inline script metadata to enable `uv run <url>` execution with automatic dependency installation. Updates example run instructions to use raw GitHub URLs for remote execution. Updates README with runnable examples and new folder structure.
@nicosuave nicosuave merged commit b90da0e into main Jan 5, 2026
10 checks passed
@nicosuave nicosuave deleted the nicosuave/organize-examples branch January 5, 2026 01:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant