[setup.py] Use PEP625-compliant lowercase 'brotli' package name PyPI now requires that wheel filenames and metadata use normalized package names following PEP 625. Modern build tooling automatically normalize this, however this does not happen for old python versions (e.g. 2.7, 3.6, 3.7) which makes their upload fail. I had to apply the same patch to the v1.2.0 release be able to upload all the python wheels to PyPI, see: https://github.com/google/brotli/issues/1327#issuecomment-3491479583 https://github.com/google/brotli-wheels/commit/ca4fed169bb72d09d0263feb34853247da9f4a45 It makes more sense to have this in here and get rid of the patch, regardless of when we drop support for those EOL pythons.
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.
Please note: brotli is a “stream” format; it does not contain meta-information, like checksums or uncompressed data length. It is possible to modify “raw” ranges of the compressed stream and the decoder will not notice that.
In most Linux distributions, installing brotli is just a matter of using the package management system. For example in Debian-based distributions: apt install brotli will install brotli. On MacOS, you can use Homebrew: brew install brotli.
Of course you can also build brotli from sources.
You can download and install brotli using the vcpkg dependency manager:
git clone https://github.com/Microsoft/vcpkg.git cd vcpkg ./bootstrap-vcpkg.sh ./vcpkg integrate install ./vcpkg install brotli
The brotli port in vcpkg is kept up to date by Microsoft team members and community contributors. If the version is out of date, please create an issue or pull request on the vcpkg repository.
See Bazel
The basic commands to build and install brotli are:
$ mkdir out && cd out $ cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=./installed .. $ cmake --build . --config Release --target install
You can use other CMake configuration.
To install the latest release of the Python module, run the following:
$ pip install brotli
To install the tip-of-the-tree version, run:
$ pip install --upgrade git+https://github.com/google/brotli
See the Python readme for more details on installing from source, development, and testing.
We glad to answer/library related questions in brotli mailing list.
Regular issues / feature requests should be reported in issue tracker.
For reporting vulnerability please read SECURITY.
For contributing changes please read CONTRIBUTING.
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
Dart compression framework with fast FFI-based Brotli implementation with ready-to-use prebuilt binaries for Win/Linux/Mac