Brotli compression format
Go to file
Eugene Kliuchnikov 541dd651e0 Merge pull request #435 from nicksay/py-1-cleanup-setup
Python: Clean up setup.py file
2016-10-17 14:31:42 +02:00
appveyor [appveyor/install.ps1] remove unused functions for miniconda 2015-10-07 12:46:16 +01:00
common Update encoder 2016-09-21 17:20:36 +02:00
dec Update encoder 2016-09-21 17:20:36 +02:00
docs Update the spec reference to RFC 7932, remove the old internet draft. 2016-08-02 13:27:29 +02:00
enc Update encoder 2016-09-21 17:20:36 +02:00
include/brotli Update encoder 2016-09-21 17:20:36 +02:00
java Add Java port of Brotli decoder. 2016-10-17 14:04:59 +02:00
python Update brotlimodule.cc 2016-09-21 16:02:32 +02:00
research Update research 2016-09-22 11:32:23 +02:00
terryfy@8bb673f441 add support for Travis CI (OS X only for now) 2015-08-14 11:28:26 +01:00
tests Add mingw support. 2016-07-28 19:32:33 -07:00
tools Update research 2016-09-22 11:32:23 +02:00
.gitignore Update build systems 2016-06-24 15:32:51 +02:00
.gitmodules Replace sais.hxx by submodule hillbig/esaxx. 2016-09-19 19:12:30 +02:00
.travis.sh .travis.sh: skip source venv on linux 2016-08-10 19:27:17 +01:00
.travis.yml Use system version of compiler with macpython 2016-10-12 15:08:41 +02:00
appveyor.yml appveyor: add Visual Studio builds (based on CMake) 2016-07-29 13:24:17 -07:00
BUILD Remove the underscore in the name of brotli libraries. #326 2016-10-12 18:24:04 +02:00
CMakeLists.txt Merge pull request #439 from fred-wang/remove-underscore 2016-10-17 14:29:38 +02:00
configure Update build systems 2016-06-24 15:32:51 +02:00
CONTRIBUTING.md Apply 80-chars limit to CONTRIBUTING.md 2016-02-18 15:20:59 +01:00
LICENSE Prepare to release 0.4.0 2016-06-14 15:07:13 +02:00
Makefile Update research 2016-09-22 11:32:23 +02:00
MANIFEST.in Move "public" to "include/brotli" 2016-08-23 14:40:33 +02:00
premake5.lua Remove the underscore in the name of brotli libraries. #326 2016-10-12 18:24:04 +02:00
README.md Add some basic build instructions in the README.md #166 2016-10-12 22:00:35 +02:00
setup.cfg Fix wheels build. 2016-06-17 20:10:31 +02:00
setup.py Python: Clean up setup.py file 2016-10-12 11:43:14 -04:00
WORKSPACE Add Java port of Brotli decoder. 2016-10-17 14:04:59 +02:00

Introduction

Brotli is a generic-purpose lossless compression algorithm that compresses data using a combination of a modern variant of the LZ77 algorithm, Huffman coding and 2nd order context modeling, with a compression ratio comparable to the best currently available general-purpose compression methods. It is similar in speed with deflate but offers more dense compression.

The specification of the Brotli Compressed Data Format is defined in RFC 7932.

Brotli is open-sourced under the MIT License, see the LICENSE file.

Brotli mailing list: https://groups.google.com/forum/#!forum/brotli

Build Status

Build instructions

Make

To build and run tests, simply do:

$ ./configure && make

If you want to install brotli, use one of the more advanced build systems below.

Bazel

See Bazel

CMake

The basic commands to build, test and install brotli are:

$ mkdir out && cd out && cmake .. && make test
$ make install

You can use other CMake configuration. For example, to build shared libraries and use a custom installation directory:

$ mkdir out-shared && \
  cd out-shared && \
  cmake .. -DBUILD_SHARED_LIBS=1 -DCMAKE_INSTALL_PREFIX='/my/install/dir/'
$ make install

Premake5

See Premake5

Python

The basic commands to build, test and install the Python binding are:

$ python setup.py build_ext test
$ python setup.py install

Benchmarks

Independent decoder implementation by Mark Adler, based entirely on format specification.

JavaScript port of brotli decoder. Could be used directly via npm install brotli