pydbhub 0.0.3

A Python library for accessing and using SQLite databases on DBHub.io

pydbhub

A Python library for accessing and using SQLite databases on DBHub.io. This is an early stage work in progress

What works now

• Run read-only queries (eg SELECT statements) on databases, returning the results as JSON
• Upload and download your databases
• List the databases in your account
• List the tables, views, and indexes present in a database
• List the columns in a table, view or index, along with their details
• List the branches, releases, tags, and commits for a database
• Generate diffs between two databases, or database revisions
• Download the database metadata (size, branches, commit list, etc.)
• Retrieve the web page URL of a database

Still to do

• Anything else people suggest and seems like a good idea. Please try it out, submits PRs to extend or fix things, and report any weirdness or bugs you encounter. :smile:

Pre-requisites

• Python version 3.7
  • Older Python releases should NOT be OK. Newer Python releases should be OK, but only Python 3.7 has been tested (so far).
• A DBHub.io API key
  • These can be generated in your Settings page, when logged in.

Installation

pip install pydbhub

Further examples

• SQL Query - Run a SQL query, return the results as JSON
• List databases - List the databases present in your account
• List tables - List the tables present in a database
• List views - List the views present in a database
• List indexes - List the indexes present in a database
• Retrieve column details - Retrieve the details of columns in a table
• List branches - List all branches of a database
• List releases - Display the releases for a database
• List tags - Display the tags for a database
• List commits - Display the commits for a database
• Generate diff between two revisions - Figure out the differences between two databases or two versions of one database
• Upload database - Upload a new database file
• Download database - Download the complete database file
• Delete database - Delete a database
• Retrieve metadata - Download the database metadata (size, branches, commit list, etc)
• Web page - Get the URL of the database file in the webUI. eg. for web browsers