rzmk/100.dathere.com

mirror of https://github.com/dathere/100.dathere.com.git synced 2025-12-19 00:29:25 +00:00

🧩 (WIP) The book "100 exercises with qsv". For new qsv users to read lessons and try out exercises either in-browser or locally in their terminal. Built with Jupyter Book.

bash binder cli csv data-engineering data-wrangling jupyter-book mybinder python qsv spreadsheet thebe

Find a file

rzmk 9b16ba864c chore: add note that a non-CSV file may render differently		2024-07-25 17:21:15 -04:00
.github/workflows	ci: attempt using PATH	2024-05-29 13:03:31 -04:00
.vscode	feat: initial commit for 100.dathere.com and first exercise	2024-05-29 09:03:38 -04:00
bash_kernel	feat: initial commit for 100.dathere.com and first exercise	2024-05-29 09:03:38 -04:00
lessons	chore: add note that a non-CSV file may render differently	2024-07-25 17:21:15 -04:00
media	docs: show Binder demo GIF	2024-05-30 21:31:06 -04:00
path_files	build: update from qsv v0.129.0 to v0.129.1	2024-07-15 16:17:16 -04:00
.gitignore	feat: initial commit for 100.dathere.com and first exercise	2024-05-29 09:03:38 -04:00
_config.yml	refactor: remove binder (complex) and move local note	2024-05-30 19:51:10 -04:00
_toc.yml	chore: show lessons in sidebar at root level	2024-07-25 17:20:41 -04:00
appendix.md	chore: add skip button for install section and refactor	2024-05-29 17:36:34 -04:00
exercises-setup.md	chore: show lessons in sidebar at root level	2024-07-25 17:20:41 -04:00
getting-started.md	feat: include Binder with preset notebook & warning about `notes.md`	2024-05-30 21:13:32 -04:00
index.md	feat: add multi-shell completions & supported spreadsheet types	2024-07-17 14:17:09 -04:00
postBuild	build: install ./bash_kernel in postBuild	2024-05-29 13:29:31 -04:00
README.md	`build`: update qsv to v0.129.0	2024-07-14 09:25:27 -04:00
requirements-local.txt	feat: initial commit for 100.dathere.com and first exercise	2024-05-29 09:03:38 -04:00
requirements.txt	refactor: remove binder (complex) and move local note	2024-05-30 19:51:10 -04:00
start	build: set metadata for .ipynb to bash	2024-05-29 13:27:16 -04:00

README.md

100.dathere.com

Try out available exercises: 100.dathere.com

This codebase includes source code for "100 exercises with qsv" found at 100.dathere.com.

How to run the Jupyter Book locally

Ensure you are using one of the following OS/software:

Windows Subsystem for Linux 2 (not Windows) running Ubuntu
macOS
Linux

Install the prerequisites:

Git
Visual Studio Code - Code editor
- Live Server extension - Local server extension (to view Jupyter Book locally and hot reload)
- Run on Save extension - Allows for auto-build on save for the file types specified in ../.vscode/settings.json
Python
uv - Python package manager

Clone the repository to your local device using Git:

git clone https://github.com/dathere/100.dathere.com.git

Change your directory into this folder book.
Run uv venv, this should generate a .venv folder.

On macOS and Linux
- Run source .venv/bin/activate
On Windows
- Run .venv\Scripts\activate

Run uv pip install -r requirements-local.txt.
Run uv pip install -e ./bash_kernel and then python -m bash_kernel.install to install the Bash kernel.
Run jb build . to build the book or save a .md, .ipynb, or .yml file in VS Code for the Run on Save extension to run relevant commands.
Right click on _build/html/index.html and click Open with Live Server which should launch a local build of the website and should reload within a few seconds each time you save a .md or .yml file in VS Code (you may need to refresh the page once Run on Save is done each time). You may need to navigate to the proper URL such as http://localhost:5500/_build/html/.

Notice

datHere and the maintainers of this repository are the current organizers of the book's content, and therefore may or may not merge pull requests and/or resolve issues/discussions at their discretion. If you need further assistance, please reach out at dathere.com/contact.