aboutsummaryrefslogtreecommitdiff
path: root/python/README.md
blob: 5b962d04aeb1daa5024095179ca3638193febb90 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
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.


[Google Python Style Guide]: https://google.github.io/styleguide/pyguide.html
[YAPF]: https://github.com/google/yapf
[YAPF usage]: https://github.com/google/yapf#usage