Commit 5683fc93 authored by nimrod's avatar nimrod
Browse files

- Added reStructuredText and metadata in setup.py checks (WIP).

parent 1a375a53

.pre-commit-config.yaml

+5 −0
Original line number Diff line number Diff line
@@ -5,3 +5,8 @@ 
    -   id: check-yaml

    -   id: check-merge-conflict

    -   id: flake8

-   repo: ./

    sha: HEAD

    hooks:

    -   id: reStructuredText

    -   id: metadata

README.rst

+5 −0
Original line number Diff line number Diff line
@@ -7,6 +7,9 @@ Python pre-commit hooks 
Ansible `pre-commit <http://pre-commit.com/>`_ hooks.



- :code:`piprot`: Checks your requirements files for out of date packages.

- :code:`metadata`: Verifies the meta-data in :code:`setup.py`.

- :code:`reStructuredText`: Checks if long string meta-data syntax are

  reStructuredText-compliant.



Installation

------------
@@ -19,6 +22,8 @@ Add the following to your :code:`.pre-commit-config.yaml`: 
      sha: v0.1.0

      hooks:

      - id: piprot

      - id: metadata

      - id: reStructuredText



License

-------

hooks.yaml

+12 −0
Original line number Diff line number Diff line
@@ -6,3 +6,15 @@ 
  entry: piprot

  args: ['--outdated']

  files: 'requirements.*\.txt$'

- id: reStructuredText

  name: Checks if long string meta-data syntax are reStructuredText-compliant.

  language: python

  entry: python

  args: ['setup.py', 'check', '--strict', '--restructuredtext', '--']

  files: setup\.py

- id: metadata

  name: Verify meta-data

  language: python

  entry: python

  args: ['setup.py', 'check', '--strict', '--metadata', '--']

  files: setup\.py