https://github.com/bitflight-devops/pyproject-fmt

This sorts and formats the pyproject.toml file in a consistent way.
https://github.com/bitflight-devops/pyproject-fmt

Last synced: 3 months ago
JSON representation

This sorts and formats the pyproject.toml file in a consistent way.

• Host: GitHub
• URL: https://github.com/bitflight-devops/pyproject-fmt
• Owner: bitflight-devops
• License: mit
• Created: 2026-02-09T16:46:50.000Z (4 months ago)
• Default Branch: main
• Last Pushed: 2026-03-01T18:27:23.000Z (4 months ago)
• Last Synced: 2026-03-01T20:47:32.049Z (4 months ago)
• Language: Python
• Size: 483 KB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: docs/contributing.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# pypfmt

[![CI](https://github.com/bitflight-devops/pyproject-fmt/actions/workflows/ci.yml/badge.svg)](https://github.com/bitflight-devops/pyproject-fmt/actions/workflows/ci.yml)

[![PyPI version](https://badge.fury.io/py/pypfmt.svg)](https://badge.fury.io/py/pypfmt)

[![codecov](https://codecov.io/gh/bitflight-devops/pyproject-fmt/branch/main/graph/badge.svg)](https://codecov.io/gh/bitflight-devops/pyproject-fmt)

[![Python 3.11+](https://img.shields.io/badge/python-3.11+-blue.svg)](https://www.python.org/downloads/)

[![uv](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json)](https://github.com/astral-sh/uv)

[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)

[![ty](https://img.shields.io/badge/type--checked-ty-blue?labelColor=orange)](https://github.com/astral-sh/ty)

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/bitflight-devops/pyproject-fmt/blob/main/LICENSE)

A Python package to sort and format pyproject.toml

## Features

- Fast and modern Python toolchain using Astral's tools (uv, ruff, ty)

- Type-safe with full type annotations

- Command-line interface built with Typer

- Comprehensive documentation with MkDocs — [View Docs](https://bitflight-devops.github.io/pyproject-fmt/)

## Installation

```bash

pip install pypfmt

```

Or using uv (recommended):

```bash

uv add pypfmt

```

## Quick Start

```python

import pypfmt

print(pypfmt.__version__)

```

### CLI Usage

```bash

# Show version

pypfmt --version

# Say hello

pypfmt hello World

```

## Development

### Prerequisites

- Python 3.11+

- [uv](https://docs.astral.sh/uv/) for package management

### Setup

```bash

git clone https://github.com/bitflight-devops/pyproject-fmt.git

cd pyproject-fmt

uv sync --all-groups

```

### Running Tests

```bash

uv run poe test

# With coverage

uv run poe test-cov

# Across all Python versions

uv run poe test-matrix

```

### Code Quality

```bash

# Run all checks (lint, format, type-check)

uv run poe verify

# Auto-fix lint and format issues

uv run poe fix

```

### Prek

```bash

prek install

prek run --all-files

```

### Documentation

```bash

uv run poe docs-serve

```

## License

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