/usr/lib/python2.7/dist-packages/hacking-0.8.0.egg-info/PKG-INFO is in python-hacking 0.8.0-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 | Metadata-Version: 1.1
Name: hacking
Version: 0.8.0
Summary: OpenStack Hacking Guidline Enforcement
Home-page: http://github.com/openstack-dev/hacking
Author: OpenStack
Author-email: openstack-dev@lists.openstack.org
License: UNKNOWN
Description: Introduction
============
hacking is a set of flake8 plugins that test and enforce the `OpenStack
Style Guidlines <http://docs.openstack.org/developer/hacking>`_.
Origin
======
Most of the additional style guidelines that OpenStack has taken on came from
the Google Python Style Guide.
http://google-styleguide.googlecode.com/svn/trunk/pyguide.html
Since then, a few more OpenStack specific ones have been added or modified.
Versioning
==========
hacking uses the major.minor.maintenance release notation, where maintenance
releases cannot contain new checks. This way projects can gate on hacking
by pinning on the major.minor number while accepting maintenance updates
without being concerned that a new version will break the gate with a new
check.
Adding additional checks
========================
Each check is a pep8 plugin so read
https://github.com/jcrocholl/pep8/blob/master/docs/developer.rst#contribute
Requirements
------------
- The check must already have community support. We do not want to dictate style, only enforce it.
- The canonical source of the OpenStack Style Guidelines is
`doc/source/index.rst
<http://docs.openstack.org/developer/hacking>`_, and hacking just enforces
them; so when adding a new check, it must be in docs/source/index.rst
- False negatives are ok, but false positives are not
- Cannot be project specific, project specific checks should be `Local Checks`_
- Docstring tests
- Registered as entry_points in `setup.cfg <setup.cfg>`_
- Error code must be in the relevant ``Hxxx`` group
Local Checks
============
hacking supports having local changes in a source tree. They can be configured
to run in two different ways. They can be registered individually, or with
a factory function.
For individual registration, put a comma separated list of pep8 compatible
check functions into the hacking section of tox.ini. Like
[hacking]
local-check = nova.tests.hacking.bad_code_is_terrible
Alternately, you can specify the location of a callable that will be called
at registration time and will be passed the registration function. The callable
should expect to call the passed in function on everything if wants to
register. Such as:
[hacking]
local-check-factory = nova.tests.hacking.factory
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Environment :: OpenStack
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Information Technology
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
|