Metadata-Version: 2.1
Name: ruff2bitbucket
Version: 0.1.0
Summary: Send your ruff results to bitbucket as annotations.
License: MIT
Author: Steven Van Ingelgem
Author-email: steven@vaningelgem.be
Requires-Python: >=3.9,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Dist: requests
Requires-Dist: ruff
Description-Content-Type: text/markdown

# Ruff2BitBucket

[ruff](https://docs.astral.sh/ruff/) is an extremely fast Python linter and code formatter, written in Rust.

[BitBucket](https://bitbucket.org/) is an Atlassian product which provides a visual git interface (basically).

With ruff2bitbucket you can run your ruff-validations and upload them as a code insight directly into BitBucket.

## Installation
```shell
pip install ruff2bitbucket
```

## Usage
Change your directory to where the configuration file is stored and run:
```shell
ruff2bitbucket [--user ...] [--pass ...]
```

⚠ It's important that you are in the right directory!

## Configuration
You should refer to the [ruff configuration docs](https://docs.astral.sh/ruff/configuration/) on how to modify your `pyproject.toml` (or `ruff.toml`, or `.ruff.toml`) in order to provide more extensive checks.

## Security
If no user or pass is passed, the environment variables are scanned for anything that looks like `USER`/`USR` and `PASS`/`PW`. When a match is found, this'll be used to attach the annotations to the current commit hash.

