Metadata-Version: 2.3
Name: ruff-jupyter-jetbrains
Version: 0.2.0
Summary: Add your description here
Requires-Dist: nbformat>=5.10.4
Requires-Python: >=3.14
Project-URL: Documentation, https://github.com/OliverSieweke/ruff-jupyter-jetbrains#readme
Project-URL: Homepage, https://github.com/OliverSieweke/ruff-jupyter-jetbrains
Project-URL: Issues, https://github.com/OliverSieweke/ruff-jupyter-jetbrains/issues
Project-URL: Repository, https://github.com/OliverSieweke/ruff-jupyter-jetbrains
Description-Content-Type: text/markdown

[![image](https://img.shields.io/badge/python-3.14-gray?style=for-the-badge&logo=python&logoColor=FFD43B&labelColor=306998)](https://www.python.org/)
[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json&style=for-the-badge)](https://docs.astral.sh/ruff/)
[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ty/main/assets/badge/v0.json&style=for-the-badge)](https://docs.astral.sh/ty/)



<!--suppress HtmlDeprecatedAttribute -->
<p align="center">
  <img width="20%" src="./assets/ruff.png" alt="Ruff Logo">
  <img width="20%" src="./assets/jetbrains.png" alt="Ruff Logo">
</p>


# Ruff-Jupyter-JetBrains

## Usage

## Development

### Setup

This project uses `uv` as a **project manager**. To set up the environment, ensure `uv` is [installed](https://docs.astral.sh/uv/getting-started/installation/) and run:

```shell
uv sync
```

To ensure code follows the project’s guidelines, install **pre-commit hooks** with:

```shell
pre-commit install
```

### **Code Standards**

`ruff` is used as a **formatter** and can be run with:

```shell
ruff format
```

`ruff` is used as a **linter,** and code can be checked with:

```shell
ruff check
```

`ty` is used as a **type checker,** and code can be checked with:

```shell
ty check
```
