Contributing

sqlcli welcomes all contributors. If you would like to make a contribution please create a fork of the repository and then submit a pull request.

Pull request check list

When creating a pull request please ensure you have completed the following:

• Run the black code formatter (black sqlcli).
• Run pytest (pytest --forked).
• Re-build the docs api reference (python scripts/docs.py build-typer-docs).
• Preview the docs (mkdocs serve)

Docs

The docs are hosted on GitHub pages at: https://samedwardes.github.io/sqlcli/. When making changes remember to do the following:

• Rebuild the API reference.

python scripts/docs.py build-typer-docs

• Check how the docs look locally.

mkdocs serve

• Publish to GitHub pages.

python scripts/docs.py publish-docs

Testing

Testing is performed with pytest. When running make sure to pass the --forked so that pytest spins up a "fresh" environment for each test. The --forked option comes from pytest-xdist.

pytest --forked

Credits

Open source libraries

Like all great open source software sqlcli is built on the shoulders of giants. sqlcli relies heavily on:

• sqlmodel
• sqlalchemy
• typer
• rich
• mkdocs-material
• and many more!

See the pyproject.toml for all requirements.

Icons and logo

Icons are from fontawesome.com.

The logo is the terminal icon.