Install

Requirements

Okdata CLI requires the following to run:

  • Python 3.7 or higher

  • make and build tools for installing Python modules; see output from make init below to see any other requirements you must install in order to install Okdata CLI

In addition it is recommended to use a tool like jq to parse and make automated decisions based on output.

Installation with pip

The quickest way to get started is by installing the latest release of Okdata CLI from PyPI with pip:

pip install okdata-cli

Installation from source

If you have git installed and would like to update incrementally from source, you can clone the Okdata CLI repository from GitHub:

git clone https://github.com/oslokommune/okdata-cli.git

If you don’t have git installed you can download the source from GitHub with one of the following:

  • From Okdata CLI’s GitHub page choose Code and then Download ZIP

  • From a terminal: curl -LO https://github.com/oslokommune/okdata-cli/archive/master.zip

Unzip the downloaded file and rename the unzipped directory to okdata-cli to follow the rest of the installation process.

Setup

Installing Okdata CLI into a virtual environment is recommended:

cd okdata-cli
python -m venv .venv
source .venv/bin/activate
make init

This will install all dependencies and enable a new command in the venv: okdata. To verify that it is installed properly and working, try listing all datasets:

okdata datasets ls

Installing and running the program will create a ~/.okdata directory where settings and caches will be stored.

Upgrade

If you have installed Okdata CLI with pip:

pip install --upgrade okdata-cli

If you have checked out the source from GitHub:

git pull
pip install -r requirements.txt

If you download the source code in zip format, redownload it and redo the steps Setup.

Uninstall

If you have installed Okdata CLI with pip:

pip uninstall okdata-cli

Otherwise simply remove the okdata-cli directory.

To remove all traces of the program, remove the ~/.okdata directory as well.