{"id":14155152,"url":"https://github.com/devsgnr/breadroll","last_synced_at":"2025-10-11T01:55:25.076Z","repository":{"id":183088974,"uuid":"648450753","full_name":"devsgnr/breadroll","owner":"devsgnr","description":"breadroll 🥟 is a simple lightweight library for data processing operations written in Typescript and powered by Bun.","archived":false,"fork":false,"pushed_at":"2024-07-28T14:29:31.000Z","size":15974,"stargazers_count":68,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2024-08-17T08:04:43.739Z","etag":null,"topics":["bun","csv","csv-parser","data-engineering","data-science","data-transformation","eda","exploratory-data-analysis","tsv","tsv-parser"],"latest_commit_sha":null,"homepage":"https://breadrolljs.vercel.app","language":"TypeScript","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/devsgnr.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","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},"funding":{"github":"devsgnr","patreon":null,"open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"lfx_crowdfunding":null,"custom":null}},"created_at":"2023-06-02T02:15:40.000Z","updated_at":"2024-08-17T08:04:51.489Z","dependencies_parsed_at":"2024-04-17T03:45:25.180Z","dependency_job_id":"578bf5db-e44c-4a89-adb0-31f31b63cda9","html_url":"https://github.com/devsgnr/breadroll","commit_stats":null,"previous_names":["devsgnr/ts_sv","devsgnr/ts_df","devsgnr/breadroll"],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devsgnr%2Fbreadroll","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devsgnr%2Fbreadroll/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devsgnr%2Fbreadroll/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devsgnr%2Fbreadroll/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/devsgnr","download_url":"https://codeload.github.com/devsgnr/breadroll/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":228821396,"owners_count":17977164,"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","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":["bun","csv","csv-parser","data-engineering","data-science","data-transformation","eda","exploratory-data-analysis","tsv","tsv-parser"],"created_at":"2024-08-17T08:02:16.570Z","updated_at":"2025-10-11T01:55:20.042Z","avatar_url":"https://github.com/devsgnr.png","language":"TypeScript","readme":"\n\u003cdiv align=\"center\"\u003e\n  \u003cimg src=\"https://raw.githubusercontent.com/devsgnr/breadroll/v0.3.1/docs/docs/assets/png/breadroll_brand.png\" /\u003e\n\u003c/div\u003e\n\n\u003cbr/\u003e\n\n\u003cdiv align=\"center\"\u003e\n\n![npm](https://img.shields.io/npm/v/breadroll)\n![breadroll test status](https://github.com/devsgnr/breadroll/actions/workflows/testing.yml/badge.svg)\n![breadroll test status](https://github.com/devsgnr/breadroll/actions/workflows/macos_testing.yml/badge.svg)\n![breadroll test status](https://github.com/devsgnr/breadroll/actions/workflows/windows_testing.yml/badge.svg)\n![GitHub Stars](https://img.shields.io/github/stars/devsgnr/breadroll)\n\n\u003c/div\u003e\n\nbreadroll 🥟 is a simple lightweight  toolkit for parsing csv, tsv, and other delimited files, performing EDA (exploratory data analysis), and data processing operations on multivariate datasets. Think pandas but written in Typescript and developed on the [Bun](https://bun.sh) Runtime.\n\n\u003cbr/\u003e\n\n- ⚡ **Fast**: breadroll is built on Bun, the all-in-one Javascript runtime built for speed\n- 📁 **File I/O**: Support for local \u0026 remote sources loved by JS developers - **Local, HTTPS, \u0026 Supabase Storage**\n- 😊 **Easy-to-use**: Compose queries using filter keywords that are simple and are easy to comprehend\n\n---\n\n### Table of Content\n\n1. \u003ca href=\"https://breadrolljs.vercel.app/docs\" target=\"_blank\"\u003eIntroduction\u003c/a\u003e\n2. \u003ca href=\"https://breadrolljs.vercel.app/docs/Breadroll\" target=\"_blank\"\u003eAPI Reference\u003c/a\u003e\n3. \u003ca href=\"https://breadrolljs.vercel.app/changelog\" target=\"_blank\"\u003eChangelog\u003c/a\u003e\n3. \u003ca href=\"https://breadrolljs.vercel.app/contribution\" target=\"_blank\"\u003eContribution Guide\u003c/a\u003e\n\n---\n\n### **Installation**\n\nSystem Requirements:\n\n- [Bun](https://bun.sh)\n- MacOS, Linux\n- Typescript \u003e= 5.1\n\n---\n\n#### Bun\nbreadroll is built on and optimized for Bun.js. You can install Bun by running the following\n```bash\ncurl https://bun.sh/install | bash\n```\ncreate a new Bun project by running\n```bash\nbun init\n```\nthen you can now install **breadroll** using\n```bash\nbun add breadroll\n```\n---\n\n### Easy API\n\nbreadroll provides an easy to use API that gets you from zero to data processing in no time, with lazy loading of these delimited files via Bun's File I/O `Bun.file()`, the file parsed based on the `DataframeReadOptions`, and convert into a `Dataframe`, and easily read out the content of the Dataframe using `.value`.\n\n```typescript\nimport Breadroll, { Dataframe } from \"breadroll\";\n\nconst csv: Breadroll = new Breadroll({ header: true });\n```\n\nExample: From one instance example above, you can open multiple `csv` files\n\n```typescript\nconst df: Dataframe\u003cT\u003e = await csv.open.local(\"./data/ds_salaries.csv\", \",\");\n```\n\n### Remote Data Sources\n\nbreadroll makes it easy to work with remote data sources with current support for HTTPS and Supabase Storage. With other remote data sources on the roadmap.\n\n```typescript\nconst df: Dataframe\u003cT\u003e = await csv.open.https(\"https://.../.../filename.csv\", \",\");\nconst df: Dataframe\u003cT\u003e = await csv.open.supabaseStorage(\"bucketName\", \"filepath\", \",\");\n```\n\n### Filtering\n\nPeform complex filtering; with various filters including range filters like `is between` that can be achieved using an optional function parameter `limit` which is the upper limit. These range filter are only effective with numbers (integers, floating-point).\n\n```typescript\ndf.filter(\"age\", \"is between\", 30, 40);\n```\n\nPerform even more complex filtering with multiple / chained filter, you can chain the filter ie. filtering the previously filtered `Dataframe`, the chained filter can be as long as you need them to be.\n\n```typescript\ndf.filter(\"age\", \"is between\", 30, 40).filter(\"salary\", \"\u003e\", 70000).filter(\"work_year\", \"==\", 2020);\n```\n\n### Data Transformation\n\nPerform whatever transformation you'd like to perform on the value of a specified column, from simple transformation like `value + 2`, to complex mathematical transformations that can be paired with the in-built [numeric constant object](/docs/NumericConstants/math)\n\n```typescript\ndf.apply({ key: \"salary\", fn: (v) =\u003e v / (40 * 4), newkey: \"per_hour\" });\n```\n\n### A Little Math\n\nGet a single number that accurately represents the underlying data with the many provided aggregation functions, the likes of average (mean), max, min, sum, count, etc. with more in development\n\n```typescript\ndf.sum(\"capital_gain\");\ndf.average(\"capital_gain\");\ndf.count;\n```\n\n---\nThis project running on bun \u003e=v1.0.22. [Bun.js](https://bun.sh) is a fast all-in-one JavaScript runtime.","funding_links":["https://github.com/sponsors/devsgnr"],"categories":["data-science"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdevsgnr%2Fbreadroll","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdevsgnr%2Fbreadroll","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdevsgnr%2Fbreadroll/lists"}