https://github.com/owid/owid-nushell
Nushell helper scripts for OWID
https://github.com/owid/owid-nushell
Last synced: 19 days ago
JSON representation
Nushell helper scripts for OWID
- Host: GitHub
- URL: https://github.com/owid/owid-nushell
- Owner: owid
- License: mit
- Created: 2023-11-18T01:21:23.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-09-02T08:24:47.000Z (8 months ago)
- Last Synced: 2025-02-12T05:44:36.052Z (2 months ago)
- Language: Nushell
- Size: 30.3 KB
- Stars: 2
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Nushell tools for Our World In Data
This repository is a collection of custom commands that I found useful for working with OWID data. It is mostly written for myself and other OWID staff members but since much of our tools are open, they should be useable by members of the public to a significant degree.
To use these tools you need a recent version of [Nushell](http://www.nushell.sh/) installed (version 0.86 or higher at the time of writing this). Then load the scripts in the owid subfolder of this repo as an overlay like this:
```
use /path/to/owid-nushell/owid
or as an overlay (to easily get rid of it via "overlay hide")
overlay use --prefix /path/to/owid-nushell/owid
```
The commands all have tab complection and help texts, so just type `owid` and hit to see what the available commands are or browse the source.
If you use the `overlay use` version, then all the commands are in scope as an overlay - you can then hide all owid commands again with `overlay hide`.
### Aliases file
If you want to save yourself some typing then the aliases might be useful. To use them do the following:
```
source /path/to/owid-nushell/aliases.nu
```
The you can access all commands by mnemonics that use the first letter per level, e.g. `owid api metadata` becomes `oam`
### Mysql
Using this requires the mysqlsh tool installed. Get in on the mac with `brew install mysql-shell`. Then add/edit a file in `~/.my.cnf` to put in the credential options (use `owid mysql profiles list`). You can add as many [client-] sections as you like to quickly switch between multiple mysql servers. For production, please make sure to use a read only account :)
```
[client]
user = grapher
password = grapher
host = localhost
port = 3307
database = grapher
[client-prod-ro]
user = ***
password = ***
host = owid-live-db
port = 3306
database = live_grapher
[client-local]
user = grapher
password = grapher
host = localhost
port = 3307
database = grapher
```