blob: 33cba567234de270e52c0d07f18d25106083a86c (
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
39
40
41
42
43
44
45
46
47
48
49
50
51
|
This directory contains the code for the Python `brotli` module,
`bro.py` tool, and roundtrip tests.
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
For development, reinstalling the module with every change is time
consuming. Instead, we recommend using the `setuptools`
"[development mode][]" to make the module available while still being
able to edit the source files.
For convenience, you may run the following commands from this directory:
$ make # Deploy the module in "development mode"
$ make tests # Test the module
$ make clean # Remove all temporary files and build output
### 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.
[PyPI]: https://pypi.org/project/Brotli/
[development mode]: https://setuptools.readthedocs.io/en/latest/setuptools.html#development-mode
[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
|
