kc3-lang/brotli/python/README.md

• Show log

  Commit

• Hash : b04f4ea1
  Author :
  Date : 2016-10-17T13:00:14
  

  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.
  

Download

$ python setup.py build_ext

$ python setup.py test

$ pip install yapf

$ yapf --in-place FILE

$ yapf --in-place --recursive DIR

Source

• python/README.md

• 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
  

Download