• Show log

    Commit

  • Hash : a8f5813b
    Author : Evgenii Kliuchnikov
    Date : 2022-11-17T13:03:09

    Update
    
    Documentation:
      - add note that brotli is a "stream" format, not an archive-like
      - regenerate .1 with Pandoc
    Build:
      - drop legacy "BROTLI_BUILD_PORTABLE" option
      - drop "BROTLI_SANITIZED" definition
    Code:
      - c: comb includes
      - c/enc: extract encoder state into separate header
      - c/enc: drop designated q10 codepath
      - c/enc: dealing better with flushing of empty stream
      - fix MSVC compilation
    API:
      - py: use library version instead of one in version.h
      - c: add plugable API to report consumed input / produced output
      - c/java: support "lean" prepared dictionaries (without copy of source)
    

  • README.md

  • This directory contains the code for the Python brotli module, bro.py tool, and roundtrip tests.

    Only Python 2.7+ is supported.

    We provide a Makefile to simplify common development commands.

    Installation

    If you just want to install the latest release of the Python brotli module, we recommend installing from PyPI:

    $ pip install brotli

    Alternatively, you may install directly from source by running the following command from this directory:

    $ make install

    Development

    You may run the following commands from this directory:

    $ make          # Build the module in-place
    
    $ make test     # Test the module
    
    $ make clean    # Remove all temporary files and build output

    If you wish to make the module available while still being able to edit the source files, you can use the setuptoolsdevelopment mode“:

    $ make develop  # Install the module in "development mode"

    Code Style

    Brotli’s code follows the Google Python Style Guide. To automatically format your code, first install YAPF:

    $ pip install yapf

    Then, to format all files in the project, you can run:

    $ make fix      # Automatically format code

    See the YAPF usage documentation for more information.