Skip to main content

tool for creating catalog from .csv tables in sqlite storage

Project description

CSVCatalog

a simple cli tool for wrangling csv files and shoving them into a sqlite database. no more manual scripts, no more headaches

What's this? 🤔

tired of messing around with csvs and databases separately? me too. that's why i built catalog. it's a simple, no-nonsense tool that lets you:

  • import csv files into a sqlite database with an interactive wizard.
  • search your data with a powerful, flexible query syntax.
  • export your data back to csv whenever you need it.
  • manage your database with a set of easy-to-use commands.

all output is beautifully formatted using rich 💅.

Getting Started 🚀

  1. install
pip install csvcatalog
  1. run a command

the basic structure is csvcatalog COMMAND [ARGS]. for example, to see all tables:

csvcatalog tables

by default, the database is stored in a user-specific data directory. you can specify a custom database file with the dbfile command:

# Optional
csvcatalog dbfile /path/to/your/database.db

Commands 🕹️

typer provides help for all commands. just run csvcatalog --help or csvcatalog <command> --help.

  • extract <file.csv>: run an interactive wizard to import a csv file into the database. you'll be prompted to set the separator, rename columns, select columns to import, and name the table.
  • tables: list all tables in the database, with their columns and row counts.
  • search <value> [targets...]: search for a value. this is the most powerful command.
  • sql "<query>": execute a raw sql query on the database.
  • export <table_name>: export a table to a csv file, with an interactive prompt to select columns and limit rows.
  • delete <table_name>: delete a table from the database.
  • purge: delete all tables from the database.
  • dbfile: change database file to another location.

the mighty search command

the search command lets you specify exactly where to look for your data. a "target" can be a table, a specific column in a table, or a column across all tables.

search for a value in all tables (default behavior):

# looks for 'jane' everywhere
csvcatalog search "jane"

search for a value in specific tables:

# looks for 'jane' in the 'users' and 'customers' tables
csvcatalog search "jane" users customers

search for a value in a specific column of a specific table:

# looks for the email in the 'email' column of the 'users' table
csvcatalog search "jane.doe@example.com" users.email

search for a value in a specific column across all tables:

# finds any entry with a 'status' of 'active' in any table
csvcatalog search "active" "*.status"

combine any of these targets in one command:

# a totally valid and powerful query
csvcatalog search "jane" users.name products

contributing are welcome 🤝

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

csvcatalog-2.4.tar.gz (11.3 kB view details)

Uploaded Source

Built Distribution

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

csvcatalog-2.4-py3-none-any.whl (14.4 kB view details)

Uploaded Python 3

File details

Details for the file csvcatalog-2.4.tar.gz.

File metadata

  • Download URL: csvcatalog-2.4.tar.gz
  • Upload date:
  • Size: 11.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.9.18 {"installer":{"name":"uv","version":"0.9.18","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for csvcatalog-2.4.tar.gz
Algorithm Hash digest
SHA256 2980e0ea33ec55e70e869f02879b209683eb528a147928e474cf2c22a2a3c8ca
MD5 c470e8749fa4d3ffa93687ecf55d74d5
BLAKE2b-256 c51ab73db2722ba14bc157824dbb616d3c0a0e4ebfb60dbbc810e21c9feeb242

See more details on using hashes here.

File details

Details for the file csvcatalog-2.4-py3-none-any.whl.

File metadata

  • Download URL: csvcatalog-2.4-py3-none-any.whl
  • Upload date:
  • Size: 14.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.9.18 {"installer":{"name":"uv","version":"0.9.18","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for csvcatalog-2.4-py3-none-any.whl
Algorithm Hash digest
SHA256 b75288cbf789547d37451fd6551f7144308547b742cb730cf204f20d19f096fe
MD5 080799d44e606f22dce85969570f1d77
BLAKE2b-256 988056bd3a4c5858a80275e361a4de006fe87516c10ca6686a067d19f4a0e716

See more details on using hashes here.

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