README.md
1This directory contains the code for the Python `brotli` module,
2`bro.py` tool, and roundtrip tests.
3
4Only Python 2.7+ is supported.
5
6We provide a `Makefile` to simplify common development commands.
7
8### Installation
9
10If you just want to install the latest release of the Python `brotli`
11module, we recommend installing from [PyPI][]:
12
13 $ pip install brotli
14
15Alternatively, you may install directly from source by running the
16following command from this directory:
17
18 $ make install
19
20### Development
21
22You may run the following commands from this directory:
23
24 $ make # Build the module in-place
25
26 $ make test # Test the module
27
28 $ make clean # Remove all temporary files and build output
29
30If you wish to make the module available while still being
31able to edit the source files, you can use the `setuptools`
32"[development mode][]":
33
34 $ make develop # Install the module in "development mode"
35
36### Code Style
37
38Brotli's code follows the [Google Python Style Guide][]. To
39automatically format your code, first install [YAPF][]:
40
41 $ pip install yapf
42
43Then, to format all files in the project, you can run:
44
45 $ make fix # Automatically format code
46
47See the [YAPF usage][] documentation for more information.
48
49
50[PyPI]: https://pypi.org/project/Brotli/
51[development mode]: https://setuptools.readthedocs.io/en/latest/setuptools.html#development-mode
52[Google Python Style Guide]: https://google.github.io/styleguide/pyguide.html
53[YAPF]: https://github.com/google/yapf
54[YAPF usage]: https://github.com/google/yapf#usage
55