README.md
1This directory contains the code for the Python `brotli` module,
2`bro.py` tool, and roundtrip tests.
3
4### Installation
5
6If you just want to install the module from source, execute the
7following from the root project directory:
8
9 $ python setup.py install
10
11### Development
12
13For development, reinstalling the module with every change is time
14consuming. Instead, we recommend using the `setuptools`
15"[development mode][]" to make the module available while still being
16able to edit the source files.
17
18We provide a `Makefile` to simplify common commands:
19
20 $ make # Deploy the module in "development mode"
21
22 $ make tests # Test the module
23
24 $ make clean # Remove all temporary files and build output
25
26### Code Style
27
28Brotli's code follows the [Google Python Style Guide][]. To
29automatically format your code, first install [YAPF][]:
30
31 $ pip install yapf
32
33Then, to format all files in the project, you can run:
34
35 $ make fix # Automatically format code
36
37See the [YAPF usage][] documentation for more information.
38
39
40[development mode]: https://setuptools.readthedocs.io/en/latest/setuptools.html#development-mode
41[Google Python Style Guide]: https://google.github.io/styleguide/pyguide.html
42[YAPF]: https://github.com/google/yapf
43[YAPF usage]: https://github.com/google/yapf#usage
44