{"id":30745486,"url":"https://github.com/williambdean/frame-search","last_synced_at":"2025-09-04T03:47:33.224Z","repository":{"id":308752997,"uuid":"1033976060","full_name":"williambdean/frame-search","owner":"williambdean","description":"A GitHub search inspired interface to DataFrames","archived":false,"fork":false,"pushed_at":"2025-08-24T10:09:30.000Z","size":314,"stargazers_count":4,"open_issues_count":8,"forks_count":1,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-08-31T12:57:18.489Z","etag":null,"topics":["data-science","dataframes","github"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/williambdean.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-08-07T16:31:54.000Z","updated_at":"2025-08-24T10:09:30.000Z","dependencies_parsed_at":"2025-08-07T18:46:44.606Z","dependency_job_id":null,"html_url":"https://github.com/williambdean/frame-search","commit_stats":null,"previous_names":["williambdean/frame-search"],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/williambdean/frame-search","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/williambdean%2Fframe-search","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/williambdean%2Fframe-search/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/williambdean%2Fframe-search/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/williambdean%2Fframe-search/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/williambdean","download_url":"https://codeload.github.com/williambdean/frame-search/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/williambdean%2Fframe-search/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":273549205,"owners_count":25125257,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-09-04T02:00:08.968Z","response_time":61,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["data-science","dataframes","github"],"created_at":"2025-09-04T03:47:28.183Z","updated_at":"2025-09-04T03:47:33.212Z","avatar_url":"https://github.com/williambdean.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Frame Search\n\n[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)\n[![Tests](https://github.com/williambdean/frame-search/actions/workflows/tests.yml/badge.svg)](https://github.com/williambdean/frame-search/actions/workflows/tests.yml)\n[![PyPI version](https://badge.fury.io/py/frame-search.svg)](https://badge.fury.io/py/frame-search)\n\nA GitHub search inspired interface to DataFrames.\n\nPowered by [`narwhals`](https://narwhals-dev.github.io/narwhals/).\n\n## Installation\n\nInstall from PyPI:\n\n```terminal\nuv add frame-search\n```\n\n## Usage\n\n### API\n\nImporting `frame_search` adds a `search` properties to pandas and polars objects.\n\n```python\n# Import to add `search` property to DataFrames\nimport frame_search  # noqa: F401\n\nimport polars as pl\n\ndf = pl.DataFrame({\n    \"name\": [\"Alice Smith\", \"Bob J. Dawkins\", \"Charlie Brown\"],\n    \"age\": [25, 30, 35],\n    \"hometown\": [\"New York\", \"New York\", \"Chicago\"]\n})\n\ndf.search('age:\u003c30 hometown:\"New York\"')\n```\n\n```text\nshape: (1, 3)\n┌─────────────┬─────┬──────────┐\n│ name        ┆ age ┆ hometown │\n│ ---         ┆ --- ┆ ---      │\n│ str         ┆ i64 ┆ str      │\n╞═════════════╪═════╪══════════╡\n│ Alice Smith ┆ 25  ┆ New York │\n└─────────────┴─────┴──────────┘\n```\n\n### Interactive Search in Marimo Notebooks\n\nUse with [`marimo`](https://marimo.io/) to create a search interface for DataFrames:\n\n```python\nimport marimo as mo\n\nsearch = mo.ui.text(label=\"DataFrame Search Query:\")\nsearch\n```\n\nThen use on a DataFrame:\n\n```python\nimport polars as pl\n\nimport frame_search  # noqa: F401\n\ndf = pl.DataFrame({\n    \"name\": [\"Alice Smith\", \"Bob J. Dawkins\", \"Charlie Brown\"],\n    \"age\": [25, 30, 35],\n    \"hometown\": [\"New York\", \"Los Angeles\", \"Chicago\"]\n})\n\ndf_filter = df.search(search.value)\n\ndf_filter\n```\n\nHere is another example in a Marimo notebook:\n\n![Marimo Example](./images/marimo-example.png)\n\n## Search Syntax\n\nThe search syntax is inspired by GitHub's search syntax. Here are some resources:\n\n- [Cheatsheet](https://gist.github.com/bonniss/4f0de4f599708c5268134225dda003e0)\n- [GitHub Docs](https://docs.github.com/en/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax)\n\nNot all syntax features are currently supported. View the [GitHub issues](https://github.com/williambdean/frame-search/issues) for planned features or to request new ones.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwilliambdean%2Fframe-search","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwilliambdean%2Fframe-search","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwilliambdean%2Fframe-search/lists"}