{"id":31879986,"url":"https://github.com/lucianosrp/frame-check","last_synced_at":"2025-10-13T00:56:49.464Z","repository":{"id":313350275,"uuid":"1042750457","full_name":"lucianosrp/frame-check","owner":"lucianosrp","description":"A static checker for dataframes!","archived":false,"fork":false,"pushed_at":"2025-10-08T14:35:24.000Z","size":105,"stargazers_count":1,"open_issues_count":3,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-10-08T15:28:32.785Z","etag":null,"topics":["lsp","pandas","parser","type-checker"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/lucianosrp.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","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,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-08-22T14:12:06.000Z","updated_at":"2025-10-08T14:35:28.000Z","dependencies_parsed_at":"2025-09-05T14:30:02.661Z","dependency_job_id":"7dadc338-9c8b-4dca-8656-82e8ad7d51e5","html_url":"https://github.com/lucianosrp/frame-check","commit_stats":null,"previous_names":["lucianosrp/frame-check"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/lucianosrp/frame-check","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lucianosrp%2Fframe-check","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lucianosrp%2Fframe-check/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lucianosrp%2Fframe-check/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lucianosrp%2Fframe-check/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/lucianosrp","download_url":"https://codeload.github.com/lucianosrp/frame-check/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lucianosrp%2Fframe-check/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279013658,"owners_count":26085298,"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-10-12T02:00:06.719Z","response_time":53,"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":["lsp","pandas","parser","type-checker"],"created_at":"2025-10-13T00:56:48.245Z","updated_at":"2025-10-13T00:56:49.456Z","avatar_url":"https://github.com/lucianosrp.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003e [!WARNING]\n\u003e This project is currently under active development and is not considered polished. You are welcome to fork it, contribute to making it more stable, or raise issues.\n---\n\n# frame-check\n**A static checker for pandas DataFrames**\n\n## Why frame-check?\n\nWorking with pandas DataFrames can be error-prone when it comes to column access. How many times have you written code like this, unsure if the column actually exists?\n\n```python\n# Will this work? 🤔\nresult = df[\"customer_id\"]\nfiltered = df[df[\"status\"] == \"active\"]\n```\n\n**The current reality:**\n- ✅ Code runs fine in development with your test data\n- ❌ Crashes in production when a column is missing\n- 😰 Hours spent debugging runtime `KeyError` exceptions\n\n## The Problem\n\nWhen accessing DataFrame columns, you typically have to choose between:\n\n1. **Manual verification** - Tediously trace through your code to verify every column reference\n2. **Runtime checks** - Add defensive programming with `if 'column' in df.columns:` everywhere\n3. **Source check** - Verify columns existence in your file or database schema\n4. **Cross your fingers** - Hope the columns exist and deal with crashes later\n\n```python\n# Defensive programming gets verbose quickly\nif 'customer_id' in df.columns and 'status' in df.columns:\n    result = df[df[\"status\"] == \"active\"][\"customer_id\"]\nelse:\n    raise ValueError(\"Missing required columns\")\n```\n\n## The Solution\n\n**frame-check** brings static analysis to pandas DataFrames - just like `mypy` does for Python types. It tracks DataFrame schemas through your code and catches column access errors *before* your code runs.\n\n### See it in action:\n\n```python\nimport pandas as pd\n\n# frame-check knows this DataFrame has columns: Name, Age, City, Salary\ndf = pd.DataFrame({\n    \"Name\": [\"Alice\", \"Bob\"],\n    \"Age\": [25, 30],\n    \"City\": [\"NYC\", \"LA\"],\n    \"Salary\": [50000, 60000]\n})\n\n# ❌ This will be caught by frame-check\nresult = df[\"customer_id\"]  # Column doesn't exist!\n```\n\n**Error output:**\n```\nexample.py:12:10 - error: Column 'customer_id' does not exist\n  |\n12| result = df[\"customer_id\"]\n  |          ^^^^^^^^^^^^^^^^^\n  |\n  | DataFrame 'df' was defined at line 4 with columns:\n  |   • Name\n  |   • Age\n  |   • City\n  |   • Salary\n  |\n```\n\n## Key Benefits\n\n- 🚀 **Catch errors early** - Find column access issues during development, not production\n- 🧠 **Smart tracking** - Understands DataFrame transformations like `groupby()`, `assign()`, and column assignments\n- 🔧 **Editor integration** - Real-time error highlighting in your favorite editor via LSP\n- 📝 **Clear diagnostics** - Helpful error messages that show exactly where DataFrames were defined\n- ⚡ **Zero runtime overhead** - Pure static analysis, no impact on your running code\n\n**frame-check** - Because DataFrame bugs shouldn't be a surprise! 🐼✨\n\n\n\n### Existing research/ solutions\n\n- [pdchecker](https://github.com/ncu-psl/pdchecker)\n- [Mypy issue](https://github.com/python/mypy/issues/17935)\n- [StaticFrame](https://github.com/static-frame/static-frame)\n\n\n### Components\n\n- **frame-check-core**: The heart of the type checker that parses Python AST and tracks DataFrame schemas\n- **frame-check-lsp**: Language Server Protocol implementation for editor integration\n- **frame-check-extensions**: Editor-specific extensions (currently supports Zed)\n\n\n## Contribute\n\nWe welcome contributions from the community! Here's how you can help:\n\n- **Report bugs**: If you find a bug or issue, please open an issue on our [GitHub repository](https://github.com/lucianosrp/frame-check).\n- **Submit pull requests**: If you have a fix or improvement, feel free to submit a pull request.\n- **Discuss features**: Join our discussion forum to share ideas and feedback.\n- **Spread the word**: Help us spread the word about **frame-check** by sharing it with your network.\n\n### Clone the repository\n\n```\ngit clone https://github.com/lucianosrp/frame-check.git\n```\n\n### Create an environment\n\n```\ncd frame-check \u0026\u0026 uv sync\n```\nEach component should then have a README.md file with instructions on how to run it.\n\n ---\n\n Born at PyconHK 2025\n ![](https://pycon.hk/_next/image?url=%2F_next%2Fstatic%2Fmedia%2Flogo.ebd84d16.png\u0026w=256\u0026q=75)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flucianosrp%2Fframe-check","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flucianosrp%2Fframe-check","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flucianosrp%2Fframe-check/lists"}