Install / Get started

Sqeleton can be installed using pip:

pip install sqeleton

Database drivers

To ensure that the database drivers are compatible with sqeleton, we recommend installing them along with sqeleton, using pip’s [] syntax:

• pip install 'sqeleton[mysql]'

• pip install 'sqeleton[postgresql]'

• pip install 'sqeleton[snowflake]'

• pip install 'sqeleton[presto]'

• pip install 'sqeleton[oracle]'

• pip install 'sqeleton[trino]'

• pip install 'sqeleton[clickhouse]'

• pip install 'sqeleton[vertica]'

• pip install 'sqeleton[dremio]'

• For BigQuery, see: https://pypi.org/project/google-cloud-bigquery/

Some drivers have dependencies that cannot be installed using pip and still need to be installed manually.

It is also possible to install several databases at once. For example:

pip install 'sqeleton[mysql, postgresql]'

Note: Some shells use " for escaping instead, like:

pip install "sqeleton[mysql, postgresql]"

Postgresql + Debian

Before installing the postgresql driver, ensure you have libpq-dev:

apt-get install libpq-dev

Connection editor

Sqeleton provides a TUI connection editor, that can be installed using:

pip install 'sqeleton[tui]'

Read more here.

What’s next?

Read the introduction and start coding!