-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
6 changed files
with
1,691 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
The MIT License (MIT) | ||
|
||
Copyright (c) 2015 Matthew Holt | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy of | ||
this software and associated documentation files (the "Software"), to deal in | ||
the Software without restriction, including without limitation the rights to | ||
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of | ||
the Software, and to permit persons to whom the Software is furnished to do so, | ||
subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in all | ||
copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS | ||
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR | ||
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER | ||
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN | ||
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,76 @@ | ||
Parse CSV with JavaScript | ||
======================================== | ||
|
||
Papa Parse is the [fastest](http://jsperf.com/javascript-csv-parsers/4) in-browser CSV (or delimited text) parser for JavaScript. It is reliable and correct according to [RFC 4180](https://tools.ietf.org/html/rfc4180), and it comes with these features: | ||
|
||
- Easy to use | ||
- Parse CSV files directly (local or over the network) | ||
- Fast mode ([is really fast](http://jsperf.com/javascript-csv-parsers/3)) | ||
- Stream large files (even via HTTP) | ||
- Reverse parsing (converts JSON to CSV) | ||
- Auto-detect delimiter | ||
- Worker threads to keep your web page reactive | ||
- Header row support | ||
- Pause, resume, abort | ||
- Can convert numbers and booleans to their types | ||
- Optional jQuery integration to get files from `<input type="file">` elements | ||
|
||
Papa Parse has **no dependencies** - not even jQuery. | ||
|
||
|
||
Homepage & Demo | ||
---------------- | ||
|
||
- [Homepage](http://papaparse.com) | ||
- [Demo](http://papaparse.com/demo) | ||
|
||
To learn how to use Papa Parse: | ||
|
||
- [Documentation](http://papaparse.com/docs) | ||
|
||
|
||
Papa Parse for Node | ||
-------------------- | ||
|
||
Papa Parse can parse a [Readable Stream](https://nodejs.org/api/stream.html#stream_readable_streams) instead of a [File](https://www.w3.org/TR/FileAPI/) when used in Node.js environments (in addition to plain strings). In this mode, `encoding` must, if specified, be a Node-supported character encoding. The `Papa.LocalChunkSize`, `Papa.RemoteChunkSize` , `download`, `withCredentials` and `worker` config options are unavailable. | ||
|
||
Additionally, [Rich Harris](https://github.com/Rich-Harris) forked this project to make **[Baby Parse](https://github.com/Rich-Harris/BabyParse)** which runs in Node.js environments. | ||
|
||
```bash | ||
$ npm install babyparse | ||
``` | ||
|
||
[Baby Parse on npm registry](https://www.npmjs.org/package/babyparse) | ||
|
||
Use it just like Papa Parse. However: | ||
|
||
- Files are not supported; strings only (you can use Node's file facilities to load file contents yourself) | ||
- Some config options are unavailable: | ||
- worker | ||
- download (you can use Node's network facilities to download files yourself) | ||
- encoding | ||
- chunk | ||
|
||
Otherwise, Baby Parse has nearly all the same functionality as Papa Parse 4.0, including the `unparse()` utility. | ||
|
||
|
||
Get Started | ||
----------- | ||
|
||
Use [papaparse.min.js](https://github.com/mholt/PapaParse/blob/master/papaparse.min.js) for production. | ||
|
||
For usage instructions, see the [homepage](http://papaparse.com) and, for more detail, the [documentation](http://papaparse.com/docs). | ||
|
||
|
||
|
||
Tests | ||
----- | ||
|
||
Papa Parse is under test. Download this repository, run `npm install`, then `npm test` to run the tests in your browser. | ||
|
||
|
||
|
||
Contributing | ||
------------ | ||
|
||
To discuss a new feature or ask a question, open an issue. To fix a bug, submit a pull request to be credited with the [contributors](https://github.com/mholt/PapaParse/graphs/contributors)! Remember, a pull request, *with test*, is best. You may also discuss on Twitter with [#PapaParse](https://twitter.com/search?q=%23PapaParse&src=typd&f=realtime) or directly to me, [@mholt6](https://twitter.com/mholt6). |
Oops, something went wrong.