feat: add qsv section (CLI, pro, web) & GitHub and qsv pro setups (#20)

* Add qsv Sub-section and GitHub for Beginners guide

* Add qsv, qsv pro & setup, qsv web, & GitHub setup

Co-authored-by: Abdurrahman <mabdurrahman303@gmail.com>

* chore: remove section

---------

Co-authored-by: Abdurrahman <mabdurrahman303@gmail.com>
This commit is contained in:
Mueez Khan 2024-03-04 11:59:58 -05:00 committed by GitHub
parent 0fbfd9f1e7
commit a07a6f7d26
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
27 changed files with 8876 additions and 102 deletions

8
docs/qsv/_category_.json Normal file
View file

@ -0,0 +1,8 @@
{
"label": "⚡ qsv",
"position": 3,
"link": {
"type": "generated-index",
"description": "Learn about qsv, the data wrangling tool!"
}
}

48
docs/qsv/qsv-cli.mdx Normal file
View file

@ -0,0 +1,48 @@
# ⚡ qsv
Meet **qsv**, your new command line tool for data wrangling!
## 💭 What's qsv?
qsv is a command line tool with 50+ commands that can perform data wrangling tasks in a relatively efficient manner.
For example, if I had a csv file that looked like this:
```csv title=prices.csv
id,fruit,cost
1,apple,5.00
2,banana,10.00
3,celery,2.00
```
Then I can use qsv to perform all sorts of commands based on the data. Maybe I want to simply count how many rows there are (not including the header row). I can run:
```bash
qsv count prices.csv
```
And the output would be `3`. But I can add flags for even more options like additionally getting the number of characters in the longest row by adding `--width` (e.g., `qsv count prices.csv --width`), and other commands also have subcommands!
## ✨ Cool Features
- **50+ commands:** There's plenty of options for users for all sorts of backgrounds to use qsv in their workflow
- **Blazingly fast:** qsv is built primarily with the Rust programming language, offering fast speeds even for very large datasets
- **Mix and match:** Combine different qsv commands and integrate qsv with other tools to enhance data wrangling
## 🛠 Install qsv
1. [Install qsv](/onboarding/qsv-setup).
2. Once installed, run `qsv --list` to list the commands available to you, and you can further learn about them by running `qsv <command> --help` where `<command>` is the command you want to learn about (e.g., `qsv count --help`).
3. Try running qsv commands on your files!
## 📊 Your first command: `qsv count`
Navigate to your desired `.csv` file on the terminal and try typing `qsv count <filename>` (where `<filename>` is the name of your file) and see what happens!
See if you can try following along in [the intro-to-count.ipynb notebook](https://nbviewer.org/github/jqnatividad/qsv/blob/master/contrib/notebooks/intro-to-count.ipynb).
## 🚀 Ready for some data wrangling?
That's just the beginning! Explore more commands, use qsv to perform various transformations, and have fun wrangling data with qsv!
Remember, qsv can help make data exciting and easy, even if you're just starting on your data journey!

63
docs/qsv/qsv-pro.mdx Normal file
View file

@ -0,0 +1,63 @@
# 💻 qsv pro
Get ready to level up your data game with **qsv pro**! 🚀
## 💭 What's qsv pro?
qsv pro is a spreadsheet data wrangling desktop app.
It offers a graphical user interface (GUI) based on the [qsv](/qsv/qsv-cli) command line interface (CLI).
## ✨ Super Features
### Spreadsheet data table viewer
![Data table viewer demo](/img/docs/qsv/qsv-pro/data-table-viewer.gif)
### Stats, frequency, and metadata data tables
import metaDemo from "/img/docs/qsv/qsv-pro/stats-frequency-metadata-demo.mp4";
<video width="100%" autoPlay loop>
<source src={metaDemo} type="video/mp4" />
</video>
### Recipes (scripts) to transform data
import recipesDemo from "/img/docs/qsv/qsv-pro/recipes-demo.mp4";
<video width="100%" autoPlay loop>
<source src={recipesDemo} type="video/mp4" />
</video>
### CKAN upload workflow
> The upload feature is getting a major update soon!
import uploadDemo from "/img/docs/qsv/qsv-pro/legacy-upload-demo.mp4";
<video width="100%" autoPlay loop>
<source src={uploadDemo} type="video/mp4" />
</video>
### Resizable panels
import resizablePanelsDemo from "/img/docs/qsv/qsv-pro/resizable-panels-demo.mp4";
<video width="100%" autoPlay loop>
<source src={resizablePanelsDemo} type="video/mp4" />
</video>
### Light & Dark themes
![Theme switch demo](/img/docs/qsv/qsv-pro/themes-demo.gif)
## 🌊 Let's Dive In!
1. [Set up qsv pro](/onboarding/qsv-pro-setup).
2. Launch qsv pro and explore the various features on your files. Just drag and drop a spreadsheet (CSV, Excel file, and more) into qsv pro and watch what happens!
3. Share your experience with your team and provide feedback to the developers.
## 🚀 Ready for a pro experience?
View, transform, and upload your spreadsheets with a streamlined GUI using qsv pro.

70
docs/qsv/qsv-web.mdx Normal file
View file

@ -0,0 +1,70 @@
# 🖱 qsv.dathere.com
qsv is also available on the web! A subset of qsv commands are available to run at [qsv.dathere.com](https://qsv.dathere.com).
## 🌱 Benefits
Here are some benefits of qsv.dathere.com:
- 👋 **User-Friendly Interface**: Built with daisyUI, qsv.dathere.com is a neat way to interact with qsv
- 🔌 **No Installation Required**: Hosted on the web and powered by the qsv CLI, no need to install the qsv CLI or qsv pro GUI
- 📱 **Platform Independence**: Simply go to the web app on a desktop/mobile browser
- 📊 **Interactive Data Previews**: A data table is generated based on command outputs
## 🌐 Accessing qsv.dathere.com
To access the qsv.dathere.com, simply visit the website: [qsv.dathere.com](https://qsv.dathere.com). It's a user-friendly platform that provides powerful data manipulation tools with just a few clicks. 🚀
## 🗺 UI Overview
### 🏡Home
"Home" is your starting point for qsv.dathere.com, a welcome page where you may begin browsing.
![Home GIF](/img/docs/qsv/qsv-web/home.gif)
### 🌐 Web
"Web" is where you may run various qsv commands on your file(s) with a point-and-click UI without having to type any CLI commands.
![Web GIF](/img/docs/qsv/qsv-web/web.gif)
### ⏱️ Benchmarks
"Benchmarks" is where you may data on qsv's performance and compare against previous versions of qsv.
![Benchmarks GIF](/img/docs/qsv/qsv-web/benchmarks.gif)
## 💻 Web commands
On the Web commands page, you'll find a grid of qsv commands with brief descriptions, many of which you may use in the browser.
Simply click on the qsv command you want to use, provide your input file(s), select various flags and potentially subcommands, then press the run button.
:::info Why can't I select certain commands?
Certain commands are unavailable since there currently isn't an automated process for integrating qsv into a web UI, so many commands were manually added for the web app.
:::
![Web commands GIF](/img/docs/qsv/qsv-web/web-commands.gif)
## Command example
For instance, let's choose the "behead" command.
This is a relatively simple command that removes the first row from your CSV, removing the header row.
| Upload by clicking the 'Choose File' button | or Drag and Drop |
| :-----------------------------------------------------------: | :----------------------------------------------------------------------: |
| ![File upload example](/img/docs/qsv/qsv-web/file-upload.png) | ![Drag and drop example](/img/docs/qsv/qsv-web/drag-and-drop-upload.png) |
Once you've uploaded the CSV file you want to work with, simply click on the 'RUN BEHEAD!' button and see what happens!
![Run button example](/img/docs/qsv/qsv-web/run-button-example.gif)
![Command preview](/img/docs/qsv/qsv-web/command-preview.png)
![Data table preview](/img/docs/qsv/qsv-web/data-table-preview.png)
![Raw output preview](/img/docs/qsv/qsv-web/raw-output-preview.png)