README.md
1# Spout
2
3[](https://packagist.org/packages/box/spout)
4[](http://opensource.box.com/badges)
5[](https://travis-ci.org/box/spout)
6[](https://scrutinizer-ci.com/g/box/spout/?branch=master)
7[](https://scrutinizer-ci.com/g/box/spout/?branch=master)
8[](https://packagist.org/packages/box/spout)
9
10Spout is a PHP library to read and write spreadsheet files (CSV, XLSX and ODS), in a fast and scalable way.
11Contrary to other file readers or writers, it is capable of processing very large files while keeping the memory usage really low (less than 3MB).
12
13Join the community and come discuss about Spout: [](https://gitter.im/box/spout?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
14
15
16## Documentation
17
18Full documentation can be found at [http://opensource.box.com/spout/](http://opensource.box.com/spout/).
19
20
21## Requirements
22
23* PHP version 7.1 or higher
24* PHP extension `php_zip` enabled
25* PHP extension `php_xmlreader` enabled
26
27## Upgrade guide
28
29Version 3 introduced new functionality but also some breaking changes. If you want to upgrade your Spout codebase from version 2 please consult the [Upgrade guide](UPGRADE-3.0.md).
30
31## Running tests
32
33The `master` branch includes unit, functional and performance tests.
34If you just want to check that everything is working as expected, executing the unit and functional tests is enough.
35
36* `phpunit` - runs unit and functional tests
37* `phpunit --group perf-tests` - only runs the performance tests
38
39For information, the performance tests take about 10 minutes to run (processing 1 million rows files is not a quick thing).
40
41> Performance tests status: [](https://travis-ci.org/box/spout)
42
43
44## Support
45
46You can ask questions, submit new features ideas or discuss about Spout in the chat room:<br>
47[](https://gitter.im/box/spout?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
48
49## Copyright and License
50
51Copyright 2017 Box, Inc. All rights reserved.
52
53Licensed under the Apache License, Version 2.0 (the "License");
54you may not use this file except in compliance with the License.
55You may obtain a copy of the License at
56
57 http://www.apache.org/licenses/LICENSE-2.0
58
59Unless required by applicable law or agreed to in writing, software
60distributed under the License is distributed on an "AS IS" BASIS,
61WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
62See the License for the specific language governing permissions and
63limitations under the License.
64
){kind=link}
){kind=link}
){kind=link}
){kind=link}
){kind=link}
){kind=link}