https://github.com/jacob-meacham/pylint-grandfather

Grandfather old code into a new pylint configuration
https://github.com/jacob-meacham/pylint-grandfather

Last synced: about 1 month ago
JSON representation

Grandfather old code into a new pylint configuration

• Host: GitHub
• URL: https://github.com/jacob-meacham/pylint-grandfather
• Owner: jacob-meacham
• License: mit
• Created: 2018-03-25T03:57:20.000Z (over 6 years ago)
• Default Branch: develop
• Last Pushed: 2022-12-08T06:36:32.000Z (almost 2 years ago)
• Last Synced: 2024-10-02T18:35:04.521Z (about 1 month ago)
• Language: Python
• Size: 26.4 KB
• Stars: 2
• Watchers: 3
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# pylint-grandfather

[![Build Status](https://travis-ci.org/jacob-meacham/pylint-grandfather.svg?branch=develop)](https://travis-ci.org/jacob-meacham/pylint-grandfather)

# Introduction

Sometimes, you have an old project that you'd like to introduce pylint to. Usually, this is a huge feat, because the old project might have hundreds or thousands (or more!) lint issues. Fixing all of these issues might actually introduce more bugs than it solves, depending on how long the project has been running. pylint-grandfather allows you to grandfather in old code, while still enforcing that all new or changed code is pylint compliant.

# Quick Start

```

pip install pylint-grandfather

pylint my_base_dir | pylint-grandfather --base_dir my_base_dir

```

Note that this will actually touch all files, so be sure to do this with a clean working directory.

# Usage

```

usage: pylint-grandfather.py [-h] [--base-dir BASE_DIR] [--dry-run DRY_RUN]

                             infile

positional arguments:

  infile               Output from a pylint run

optional arguments:

  -h, --help           show this help message and exit

  --base-dir BASE_DIR  Base directory for pylint run

  --dry-run DRY_RUN    Output what files will be changed, but do not change

                       them

```

# Release Notes

* 1.0.0 - Initial version