feat: add initial sql formatting tool

[vaeng]

This file is supposed to end up as a github action at some point to keep our code consistent.

For now let's discuss the changes it makes:

• split lines at 120 chars
• change keywords to uppercase
• change identifiers to lowecase
• reindent

Details here: https://sqlparse.readthedocs.io/en/latest/api/#formatting-of-sql-statements

[glennj]

Is there an npm-like tool for python?

[vaeng]

Is there an npm-like tool for python?

There are some alternatives.

[IsaacG]

Are we going the Python-route for tooling? Should I assume Python and use Python to make exercise generators?

[IsaacG]

Suggested change

	import argparse
	#!/usr/bin/env python
	import argparse

[IsaacG]

Rather than building your own output, do you just want difflib.ndiff()?

[vaeng]

I tested it a bit, but it did not really do what I hoped to see. Maybe my config was off?

[IsaacG]

pathlib is the modern library for path operations.

[IsaacG]

Does this break on trailing comments? Does this mean any line starting with a space is assumed to be a comment?

[vaeng]

I should escape the dot.
Trailing comments stay trailing with the normal parser, but single-line comments would be added after the last SQL statement, that did not look right for me, so I changed it.

[IsaacG]

pathlib.walk() or pathlib.rglob("*") might be easier to use.

pathlib also supports a pathlib.rename() and read_text() etc

[IsaacG]

Is there an npm-like tool for python?

I would suggest pip

[glennj]

Is there an npm-like tool for python?

I would suggest pip

As a relative python newbie, what's the process for installing needed libraries?

1. run the script
2. no errors? we're done.
3. get an error
4. manually pip install
5. go to 1

[IsaacG]

For every import statement, the library must either (1) be part of the Standard Library or (2) pip install $library.

[glennj]

I'll hold off on any further python library objections. Perhaps all that's required, once we see how much python tooling this track gets, is a documented list in CONTRIBUTING.md which libraries need installing.

[vaeng]

I'll hold off on any further python library objections. Perhaps all that's required, once we see how much python tooling this track gets, is a documented list in CONTRIBUTING.md which libraries need installing.

We could have a requirements file, that can be fed into pip. This is how many projects ensure that the libs are where they are needed. It is a pretty smooth process in my experience.

I understand, that the dependencies are easy to handle if we use bash only, but I have to admit, that it takes me a lot longer to configure the tooling if I write it in bash. Github actions seem quite capable of running Python script in a dependable manner as well.

For tooling that is probably used by students, I want to keep the requirements low. For the maintenance side, I am open to using the things that bring this track online and ready in the best way.

[IsaacG]

Is there an npm-like tool for python?

Typically pip from what I've seen in GHAs.

[IsaacG]

Ping :)