lib/spout/README.md

   1 # Spout
   2
   3 [![Latest Stable Version](https://poser.pugx.org/box/spout/v/stable)](https://packagist.org/packages/box/spout)
   4 [![Project Status](http://opensource.box.com/badges/active.svg)](http://opensource.box.com/badges)
   5 [![Build Status](https://travis-ci.org/box/spout.svg?branch=master)](https://travis-ci.org/box/spout)
   6 [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/box/spout/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/box/spout/?branch=master)
   7 [![Code Coverage](https://scrutinizer-ci.com/g/box/spout/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/box/spout/?branch=master)
   8 [![Total Downloads](https://poser.pugx.org/box/spout/downloads)](https://packagist.org/packages/box/spout)
   9
  10 Spout is a PHP library to read and write spreadsheet files (CSV, XLSX and ODS), in a fast and scalable way.
  11 Contrary 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
  13 Join the community and come discuss about Spout: [![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/box/spout?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
  14
  15
  16 ## Documentation
  17
  18 Full 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
  29 Version 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
  33 The `master` branch includes unit, functional and performance tests.
  34 If 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
  39 For 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: [![Build Status](https://travis-ci.org/box/spout.svg?branch=perf-tests)](https://travis-ci.org/box/spout)
  42
  43
  44 ## Support
  45
  46 You can ask questions, submit new features ideas or discuss about Spout in the chat room:<br>
  47 [![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/box/spout?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
  48
  49 ## Copyright and License
  50
  51 Copyright 2017 Box, Inc. All rights reserved.
  52
  53 Licensed under the Apache License, Version 2.0 (the "License");
  54 you may not use this file except in compliance with the License.
  55 You may obtain a copy of the License at
  56
  57    http://www.apache.org/licenses/LICENSE-2.0
  58
  59 Unless required by applicable law or agreed to in writing, software
  60 distributed under the License is distributed on an "AS IS" BASIS,
  61 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  62 See the License for the specific language governing permissions and
  63 limitations under the License.