Skip to main content

Terminal-based SQLite manager

Project description

SQTerm Logo

SQTerm is a fast, modular, lightweight, terminal SQLite tool written in Python.
Built for when you don’t want a bloated GUI and just need to get work done — fast.


🚀 Features

  • 🔹 Execute raw SQL commands directly
  • 🔹 Clean table output with tabulate
  • 🔹 Import large CSV files into tables (fast, petl-backed)
  • 🔹 Export entire tables or query results to CSV
  • 🔹 View tables and their structure
  • 🔹 Show simple database statistics
  • 🔹 Switch between .db files mid-session
  • 🔹 Error handling with clear messages
  • 🔹 Remove any unused feature by simply deleting a single file
  • 🔹 Write your own feature easily in a simple format when preinstalled features don't meet your needs

Tested on tables and .csv files with up to 10 million rows. No problem.


⬇️ Installation

pip:

pip install sqterm

pipx:

pipx install sqterm


🔧 Making your own commands

To make your own command simply create a .py file titled exactly what the user has to type to execute the command.

Each command consists of two required functions:

  • info() – returns a short description of the command
  • main(state, i) – contains the command logic

Example of an info() function:

def info():
    return '"IMPORTCSV" - Imports a CSV file as a new table'

Example of a main() function:

def main(state, i):
    print("Hello from this command!")

If your script needs access to things such as the database path, the SQLite connection, or the cursor, you can retrieve them from the state argument:

name = state["name"]
conn = state["conn"]
cursor = state["cursor"]

If you need the raw user input that triggered the command, you can access it via the i argument passed into main(). Once you've written your command simply drop it into the commands folder, start SQTerm and your command should work seamlessly when executed (you can also type help to see if your command shows up)


🛠 Requirements for running source code

  • Python 3.x
  • Libraries:
    • petl
    • sqlalchemy
    • tabulate
    • psutil

Install them with:

pip install petl sqlalchemy tabulate psutil

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

sqterm-1.3.4a1.tar.gz (10.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

sqterm-1.3.4a1-py3-none-any.whl (15.0 kB view details)

Uploaded Python 3

File details

Details for the file sqterm-1.3.4a1.tar.gz.

File metadata

  • Download URL: sqterm-1.3.4a1.tar.gz
  • Upload date:
  • Size: 10.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for sqterm-1.3.4a1.tar.gz
Algorithm Hash digest
SHA256 4fcc4360137996742086af20dce4d30c57233aa569486658dd9e350c8f1b94b6
MD5 110f04d8d7a2f08d3043f9d4b972544e
BLAKE2b-256 893a9559e25f02fb33e2cb506b9daa6eafc16ac66ace55eec83359b1cbdeefbe

See more details on using hashes here.

Provenance

The following attestation bundles were made for sqterm-1.3.4a1.tar.gz:

Publisher: python-publish.yml on Gamerbot1000/SQTerm

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file sqterm-1.3.4a1-py3-none-any.whl.

File metadata

  • Download URL: sqterm-1.3.4a1-py3-none-any.whl
  • Upload date:
  • Size: 15.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for sqterm-1.3.4a1-py3-none-any.whl
Algorithm Hash digest
SHA256 f10cb606032753687a9398f8d5d5ee2084e48b0d20a0b3e96ab5584a9a505699
MD5 785e3ef8987d5078346f858b048c829d
BLAKE2b-256 3d2d1a1d77cc6fc161c4525297105f50296ac1727aeaad6216f42e55a191414b

See more details on using hashes here.

Provenance

The following attestation bundles were made for sqterm-1.3.4a1-py3-none-any.whl:

Publisher: python-publish.yml on Gamerbot1000/SQTerm

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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