File tree 3 files changed +41
-4
lines changed
3 files changed +41
-4
lines changed Original file line number Diff line number Diff line change @@ -50,11 +50,13 @@ See [Premake5](https://premake.github.io/)
50
50
51
51
#### Python
52
52
53
- The basic commands to build, test and install the Python binding are:
53
+ The basic commands to build, test, and install the Python module are:
54
54
55
55
$ python setup.py build_ext test
56
56
$ python setup.py install
57
57
58
+ See the [ Python readme] ( python/README.md ) for more details.
59
+
58
60
### Benchmarks
59
61
* [ Squash Compression Benchmark] ( https://quixdb.github.io/squash-benchmark/ ) / [ Unstable Squash Compression Benchmark] ( https://quixdb.github.io/squash-benchmark/unstable/ )
60
62
* [ Large Text Compression Benchmark] ( http://mattmahoney.net/dc/text.html )
Original file line number Diff line number Diff line change 1
- This directory contains Python brotli wrapper module and roundtrip tests.
1
+ This directory contains the code for the Python ` brotli ` module,
2
+ ` bro.py ` tool, and roundtrip tests.
2
3
3
- To build module execute ` python setup.py build_ext ` from root project directory.
4
4
5
- To test module run ` python setup.py test ` .
5
+ ### Development
6
+
7
+ To build the module, execute the following from the root project
8
+ directory:
9
+
10
+ $ python setup.py build_ext
11
+
12
+ To test the module, execute the following from the root project
13
+ directory:
14
+
15
+ $ python setup.py test
16
+
17
+
18
+ ### Code Style
19
+
20
+ Brotli's code follows the [ Google Python Style Guide] [ ] . To
21
+ automatically format your code, install [ YAPF] [ ] :
22
+
23
+ $ pip install yapf
24
+
25
+ Then, either format a single file:
26
+
27
+ $ yapf --in-place FILE
28
+
29
+ Or, format all files in a directory:
30
+
31
+ $ yapf --in-place --recursive DIR
32
+
33
+ See the [ YAPF usage] [ ] documentation for more information.
34
+
35
+
36
+ [ Google Python Style Guide ] : https://google.github.io/styleguide/pyguide.html
37
+ [ YAPF ] : https://github.com/google/yapf
38
+ [ YAPF usage ] : https://github.com/google/yapf#usage
Original file line number Diff line number Diff line change 1
1
[build]
2
2
build-base =bin
3
3
4
+ [yapf]
5
+ based_on_style =google
You can’t perform that action at this time.
0 commit comments