Skip to main content

An uncompromising SQL query formatter.

Project description

SQLFMT

SQLFMT - An uncompromising SQL query formatter.

PyPI Latest Release Package Status Code style: black Imports: isort

SQLFMT is an uncompromising SQL query formatter, which provides one and only one way to format the SQL query. Our goal is to make code reviews faster by producing the smallest diffs possible. You will save time and mental energy on more important matters.

Please note this project is still in the planning stage and everything may be changed in the future.

How to install SQLFMT?

You can install SQLFMT from Python Package Index:

pip install sqlfmt

How to use SQLFMT?

Given a SQL file, you can simply use the following command to format it:

sqlfmt path/to/file.sql

You can install completion for a specfic shell:

sqlfmt --install-completion bash

You can also run the following command to find more other options:

sqlfmt --help

How does SQLFMT work?

It formats your SQL code in place.

For example, if you have a file containing the following SQL code:

SeLEct  1, blah as  fOO  from myTable

after running SQLFMT, the content of that file will become:

SELECT
  1,
  blah AS foo
FROM mytable

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sqlfmt-0.0.3.tar.gz (3.0 kB view hashes)

Uploaded Source

Built Distribution

sqlfmt-0.0.3-py3-none-any.whl (3.5 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page