From 4170b730e6eb3468a9a85145c5a975ba8db88166 Mon Sep 17 00:00:00 2001 From: Joel Natividad <1980690+jqnatividad@users.noreply.github.com> Date: Sat, 2 Nov 2024 21:28:32 -0400 Subject: [PATCH] docs: add `template` command to list of available commands [skip ci] --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 109920ec1..93066b99b 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,7 @@   | Table of Contents :--------------------------|:------------------------- -![qsv logo](docs/images/qsv-logo.png)
[_Hi-ho "Quicksilver" away!_](https://www.youtube.com/watch?v=p9lf76xOA5k)
[logo details](https://github.com/jqnatividad/qsv/discussions/295)
|qsv is a command line program for querying, slicing,
indexing, analyzing, filtering, enriching, transforming,
sorting, validating, joining & converting tabular data
(CSV, spreadsheets, [etc.](#file-formats)).
Commands are simple, composable & ___"blazing fast"___.

* [Commands](#available-commands)
* [Installation Options](#installation-options)
* [Whirlwind Tour](docs/whirlwind_tour.md#a-whirlwind-tour) / [Notebooks](contrib/notebooks/) / [Lessons & Exercises](https://100.dathere.com)
* [Cookbook](https://github.com/jqnatividad/qsv/wiki/Cookbook#cookbook)
* [FAQ](https://github.com/jqnatividad/qsv/discussions/categories/faq)
* [Performance Tuning](docs/PERFORMANCE.md#performance-tuning)
* 👉 [Benchmarks](https://qsv.dathere.com/benchmarks) 🚀
* [Environment Variables](docs/ENVIRONMENT_VARIABLES.md)
* [Feature Flags](#feature-flags)
* [Goals/Non-goals](#goals--non-goals)
* [Testing](#testing)
* [NYC School of Data 2022](https://docs.google.com/presentation/d/e/2PACX-1vQ12ndZL--gkz0HLQRaxqsNOwzddkv1iUKB3sq661yA77OPlAsmHJHpjaqt9s9QEf73VqMfb0cv4jHU/pub?start=false&loop=false&delayms=3000)/[csv,conf,v8](https://docs.google.com/presentation/d/10T_3MyIqS5UsKxJaOY7Ktrd-GfhJelQImlE_qYmtuis/edit#slide=id.g2e0f1e7aa0e_0_62) slides
* [Sponsor](#sponsor) +![qsv logo](docs/images/qsv-logo.png)
[_Hi-ho "Quicksilver" away!_](https://www.youtube.com/watch?v=p9lf76xOA5k)
[logo details](https://github.com/jqnatividad/qsv/discussions/295)
|qsv is a command line program for querying, slicing,
indexing, analyzing, filtering, enriching, transforming,
sorting, validating, joining, formatting & converting
tabular data (CSV, spreadsheets, [etc.](#file-formats)).
Commands are simple, composable & ___"blazing fast"___.

* [Commands](#available-commands)
* [Installation Options](#installation-options)
* [Whirlwind Tour](docs/whirlwind_tour.md#a-whirlwind-tour) / [Notebooks](contrib/notebooks/) / [Lessons & Exercises](https://100.dathere.com)
* [Cookbook](https://github.com/jqnatividad/qsv/wiki/Cookbook#cookbook)
* [FAQ](https://github.com/jqnatividad/qsv/discussions/categories/faq)
* [Performance Tuning](docs/PERFORMANCE.md#performance-tuning)
* 👉 [Benchmarks](https://qsv.dathere.com/benchmarks) 🚀
* [Environment Variables](docs/ENVIRONMENT_VARIABLES.md)
* [Feature Flags](#feature-flags)
* [Goals/Non-goals](#goals--non-goals)
* [Testing](#testing)
* [NYC School of Data 2022](https://docs.google.com/presentation/d/e/2PACX-1vQ12ndZL--gkz0HLQRaxqsNOwzddkv1iUKB3sq661yA77OPlAsmHJHpjaqt9s9QEf73VqMfb0cv4jHU/pub?start=false&loop=false&delayms=3000)/[csv,conf,v8](https://docs.google.com/presentation/d/10T_3MyIqS5UsKxJaOY7Ktrd-GfhJelQImlE_qYmtuis/edit#slide=id.g2e0f1e7aa0e_0_62) slides
* [Sponsor](#sponsor)
@@ -84,6 +84,7 @@ | [sqlp](/src/cmd/sqlp.rs#L2)
✨🚀🐻‍❄️🗄️🪄 | Run [Polars](https://pola.rs) SQL queries against several CSVs - converting queries to blazing-fast [LazyFrame](https://docs.pola.rs/user-guide/lazy/using/) expressions, processing larger than memory CSV files. Query results can be saved in CSV, JSON, JSONL, Parquet, Apache Arrow IPC and Apache Avro formats. | | [stats](/src/cmd/stats.rs#L2)
📇🤯🏎️👆🪄 | Compute [summary statistics](https://en.wikipedia.org/wiki/Summary_statistics) (sum, min/max/range, sort order, min/max/sum/avg length, mean, standard error of the mean (SEM), stddev, variance, Coefficient of Variation (CV), nullcount, max precision, sparsity, quartiles, Interquartile Range (IQR), lower/upper fences, skewness, median, mode/s, antimode/s & cardinality) & make GUARANTEED data type inferences (Null, String, Float, Integer, Date, DateTime, Boolean) for each column in a CSV ([more info](https://github.com/jqnatividad/qsv/wiki/Supplemental#stats-command-output-explanation)).
Uses multithreading to go faster if an index is present (with an index, can compile "streaming" stats on NYC's 311 data (15gb, 28m rows) in less than 7.3 seconds!). | | [table](/src/cmd/table.rs#L2)
🤯 | Show aligned output of a CSV using [elastic tabstops](https://github.com/BurntSushi/tabwriter). To interactively view a CSV, use the `lens` command. | +| [template](/src/cmd/template.rs#L2)
| Create formatted output from CSV data using the [MiniJinja](https://docs.rs/minijinja/latest/minijinja/) template engine . | | [to](/src/cmd/to.rs#L2)
✨🚀🗄️ | Convert CSV files to [PostgreSQL](https://www.postgresql.org), [SQLite](https://www.sqlite.org/index.html), XLSX and [Data Package](https://datahub.io/docs/data-packages/tabular). | | [tojsonl](/src/cmd/tojsonl.rs#L3)
📇😣🚀🔣🪄 | Smartly converts CSV to a newline-delimited JSON ([JSONL](https://jsonlines.org/)/[NDJSON](http://ndjson.org/)). By scanning the CSV first, it "smartly" infers the appropriate JSON data type for each column. See `jsonl` command to convert JSONL to CSV. | | [transpose](/src/cmd/transpose.rs#L2)
🤯 | Transpose rows/columns of a CSV. | @@ -494,7 +495,7 @@ Dual-licensed under MIT or the [UNLICENSE](https://unlicense.org). ## Origins -qsv is a fork of the popular [xsv](https://github.com/BurntSushi/xsv) utility, merging several pending PRs [since xsv 0.13.0's May 2018 release](https://github.com/BurntSushi/xsv/issues/267). On top of xsv's 20 commands, it adds numerous new features; 41 additional commands; 4 `apply` subcommands & 38 operations; 4 `to` subcommands; 3 `cat` subcommands; 7 `geocode` subcommands & 4 index operations; and 4 `snappy` subcommands. +qsv is a fork of the popular [xsv](https://github.com/BurntSushi/xsv) utility, merging several pending PRs [since xsv 0.13.0's May 2018 release](https://github.com/BurntSushi/xsv/issues/267). On top of xsv's 20 commands, it adds numerous new features; 42 additional commands; 4 `apply` subcommands & 38 operations; 4 `to` subcommands; 3 `cat` subcommands; 7 `geocode` subcommands & 4 index operations; and 4 `snappy` subcommands. See [FAQ](https://github.com/jqnatividad/qsv/discussions/categories/faq) for more details. ## Sponsor