brotli/python
Alex Nicksay b04f4ea185 Python: Update README with information about code formatting
Also, add a `yapf` section to `setup.cfg` to ensure YAPF runs
format code with the Google style.
2016-10-17 13:57:56 -04:00
..
tests Restore platform suffix 2016-06-17 20:24:24 +02:00
_brotli.cc Python: Create native brotli module and move extension to _brotli 2016-10-17 09:35:27 -04:00
bro.py Add binding for custom_dictionary. 2016-02-23 17:42:55 +01:00
brotli.py Python: Create native brotli module and move extension to _brotli 2016-10-17 09:35:27 -04:00
README.md Python: Update README with information about code formatting 2016-10-17 13:57:56 -04:00

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

Development

To build the module, execute the following from the root project directory:

$ python setup.py build_ext

To test the module, execute the following from the root project directory:

$ python setup.py test

Code Style

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

$ pip install yapf

Then, either format a single file:

$ yapf --in-place FILE

Or, format all files in a directory:

$ yapf --in-place --recursive DIR

See the YAPF usage documentation for more information.