pandas-vet 0.0.2.dev0

A flake8 plugin to lint pandas in an opinionated way

pandas-vet

pandas-vet is a plugin for flake8 that provides opinionated linting for pandas code.

It began as a project during the PyCascades 2019 sprints.

Motivation

Starting with pandas can be daunting. The usual internet help sites are littered with different ways to do the same thing and some features that the pandas docs themselves discourage live on in the API. pandas-vet is (hopefully) a way to help make pandas a little more friendly for newcomers by taking some opinionated stances about pandas best practices. It is designed to help users reduce the pandas universe.

Many of the opinions stem from Ted Petrou's excellent Minimally Sufficient Pandas. Other ideas are drawn from pandas docs or elsewhere. The Pandas in Black and White flashcards have a lot of the same opinions too.

Installation

pandas-vet is a plugin for flake8. If you don't have flake8 already, it will install automatically when you install pandas-vet.

Usage

Once installed successfully in an environment that also has flake8 installed, pandas-vet should run whenever flake8 is run.

$ flake8 ...

See the flake8 docs for more information.

Contributing

pandas-vet is still in the very early stages. Contributions are welcome from the community on codes, tests, docs, and just about anything else.

Please submit an issue (or draft PR) first describing the types of changes you'd like to implement.

We use pytest and flake8 to validate our codebase. The TravisCI integration will complain on Pull Requests if there are any failing tests or lint violations. To check these locally, run the following commands:

pytest tests

flake8 pandas_vet setup.py tests --exclude tests/data

Code of Conduct

Because this project started during the PyCascades 2019 sprints, we adopt the PyCascades minimal expectation that we "Be excellent to each another". Beyond that, we follow the Python Software Foundation's Community Code of Conduct.