Metadata-Version: 2.4
Name: pandas-linter
Version: 0.1.0
Summary: Static linter to optimize Pandas/Numpy code
Author-email: Jean Estevez <ctarriba9@gmail.com>
Maintainer-email: Jean Estevez <ctarriba9@gmail.com>
License: MIT License
        
        Copyright (c) 2025 Jean Estevez
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: Homepage, https://github.com/Jean-EstevezT/pandas_lint
Project-URL: Repository, https://github.com/Jean-EstevezT/pandas_lint
Project-URL: Issues, https://github.com/Jean-EstevezT/pandas_lint/issues
Keywords: pandas,lint,static analysis,optimization,data science
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Topic :: Software Development :: Quality Assurance
Classifier: Topic :: Scientific/Engineering :: Information Analysis
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: click
Requires-Dist: rich
Requires-Dist: toml
Requires-Dist: libcst
Provides-Extra: dev
Requires-Dist: pytest; extra == "dev"
Requires-Dist: pytest-cov; extra == "dev"
Requires-Dist: black; extra == "dev"
Requires-Dist: isort; extra == "dev"
Requires-Dist: flake8; extra == "dev"
Requires-Dist: build; extra == "dev"
Requires-Dist: twine; extra == "dev"
Dynamic: license-file

# pandas_lint

![PyPI - Version](https://img.shields.io/pypi/v/pandas-linter)
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pandas-linter)
![License](https://img.shields.io/github/license/Jean-EstevezT/pandas_lint)

**pandas_lint** is a static code analysis tool designed to help you write more efficient and readable Pandas and NumPy code. It detects common anti-patterns and performance bottlenecks, offering suggestions to improve your data processing pipelines.

## Features

- **Performance Optimization**: Identifies slow operations like `apply()`, usage of `iterrows()`, and inefficient string manipulations.
- **Best Practices**: Enforces standard Pandas coding styles and conventions.
- **Safety**: Warns about potential issues like `SettingWithCopyWarning` risks and modification of views.
- **Easy Integration**: Zero-config needed to get started, but fully configurable via `pyproject.toml`.

## Installation

You can install `pandas_lint` directly from PyPI:

```bash
pip install pandas-linter
```

## Usage

### Command Line Interface

To lint a file or directory:

```bash
pandas-lint path/to/your/script.py
pandas-lint path/to/your/project/
```

To automatically fix issues where possible (experimental):

```bash
pandas-lint path/to/script.py --autofix
```

### Configuration

You can configure `pandas_lint` in your `pyproject.toml` file:

```toml
[tool.pandas-linter]
ignore = ["STY001", "PERF002"]
```

## Contributing

We welcome contributions! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for details on how to get started.

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

