4f455cac32
* [appveyor] remove 'deploy' stage; only test python 2.7 and 3.6 all the other python versions are being built and tested on https://github.com/google/brotli-wheels/blob/d571d63/appveyor.yml * remove terrify submodule as not needed any more * [travis] just test py2.7 and 3.6 on linux; remove extra osx python builds All the other python versions for OSX are being built/tested on: https://github.com/google/brotli-wheels/blob/d571d63/.travis.yml Also, there's no need to build and deploy wheels here, as that's done in the separate repository. * [setup.py] only rebuild if dependency are newer; fix typo in list of 'depends' https://github.com/python/cpython/blob/v3.6.2/Lib/distutils/command/build_ext.py#L485-L500 * [ci] only run 'python setup.py test' if we run 'python setup.py built test', the setuptools 'test' command will forcibly re-run the build_ext subcommand because it wants to pass the --inplace option (it ignores whether it's up to date, just re-runs it all the time). with this we go from running built_ext twice, to running it only once per build * [Makefile] run 'build_ext --inplace' instead of 'develop' as default target The 'develop' command is like 'install' in the sense that it modifies the user's python environment. The default make target should be less intrusive, i.e. just building the extension module in-place without modify anything in the user's environment. We don't need to tell make about the dependency between 'test' and 'build' target as that is baked in the `python setup.py test` command. * [Makefile] add 'develop' target; remove unnecessary 'tests' target `make test` is good enough * [Makefile] `setup.py test` requires setuptools; run `python -m unittest` This will work even if setuptools is not installed, which is unlikely nowadays but still our `setup.py` works with plain distutils, so we may well have our tests work without setuptools. * [python/README.md] add ref to 'develop' target; remove 'tests', just 'make test' * [setup.py] import modules as per nicksay's comment https://github.com/google/brotli/pull/583#discussion_r131981049 * [Makefile] add 'develop' to .PHONY targets remove 'tests' from .PHONY * [appveyor] remove unused setup scripts We don't need to install custom python versions, we are using the pre-installed ones on Appveyor. * [appveyor] remove unneeded setup code |
||
|---|---|---|
| c | ||
| csharp | ||
| docs | ||
| go/cbrotli | ||
| java/org/brotli | ||
| python | ||
| research | ||
| scripts | ||
| tests | ||
| .editorconfig | ||
| .gitignore | ||
| .gitmodules | ||
| .travis.yml | ||
| BUILD | ||
| CMakeLists.txt | ||
| configure | ||
| configure-cmake | ||
| CONTRIBUTING.md | ||
| LICENSE | ||
| Makefile | ||
| MANIFEST.in | ||
| premake5.lua | ||
| README.md | ||
| setup.cfg | ||
| setup.py | ||
| WORKSPACE | ||
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 instructions
Autotools-style CMake
configure-cmake is an autotools-style configure script for CMake-based projects.
The basic commands to build, test and install brotli are:
$ mkdir out && cd out
$ ../configure-cmake
$ make
$ make test
$ make install
To build static libraries use --disable-shared-libs argument:
$ mkdir out-static && cd out-static
$ ../configure-cmake --disable-shared-libs
$ make install
Bazel
See Bazel
CMake
The basic commands to build, test and install brotli are:
$ mkdir out && cd out
$ cmake ..
$ make
$ make test
$ make install
You can use other CMake configuration. For example, to build static libraries:
$ mkdir out-static && cd out-static
$ cmake .. -DBUILD_SHARED_LIBS=OFF
$ make
Premake5
See Premake5
Python
To install the latest release of the Python module, run the following:
$ pip install brotli
See the Python readme for more details on installing from source, development, and testing.
Benchmarks
- Squash Compression Benchmark / Unstable Squash Compression Benchmark
- Large Text Compression Benchmark
- Lzturbo Benchmark
Related projects
Disclaimer: Brotli authors take no responsibility for the third party projects mentioned in this section.
Independent decoder implementation by Mark Adler, based entirely on format specification.
JavaScript port of brotli decoder. Could be used directly via npm install brotli
Hand ported decoder / encoder in haxe by Dominik Homberger. Output source code: JavaScript, PHP, Python, Java and C#
7Zip plugin