Virtualization
/
brotli
mirror of https://github.com/google/brotli
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
brotli/python/README.md

39 lines
853 B
Markdown
Raw Normal View History

Python: Update README with information about code formatting Also, add a `yapf` section to `setup.cfg` to ensure YAPF runs format code with the Google style.
2016-10-18 01:00:14 +08:00
This directory contains the code for the Python `brotli` module,
`bro.py` tool, and roundtrip tests.
Create README.md
2016-02-23 23:06:31 +08:00
Python: Update README with information about code formatting Also, add a `yapf` section to `setup.cfg` to ensure YAPF runs format code with the Google style.
2016-10-18 01:00:14 +08:00
### Development
To build the module, execute the following from the root project
directory:
Python: Use "build" instead of "build_ext" in scripts (#460) Previously, the Python package consisted of a single extension module, so `build_ext` was sufficient. Now, the package contains a native module and an extension module, so both `build_py` and `build_ext` are required. Instead, run `build`, which calls both `build_py` and `build_ext` automatically.
2016-10-31 19:58:45 +08:00
$ python setup.py build
Python: Update README with information about code formatting Also, add a `yapf` section to `setup.cfg` to ensure YAPF runs format code with the Google style.
2016-10-18 01:00:14 +08:00
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