dawgtools

This package is intended to be used in the am-dawg-tool environment. Some setup is required before the first use...

installation and use

The commands below are intended to be run from within a bash shell. VS Code is the recommended terminal environment:

https://code.visualstudio.com/docs/terminal/basics

At the powershell prompt, start a bash shell:

bash

uv

We will use uv to manage python versions and dependencies. The instructions in this section only need to be completed once. The first step is to install uv.

See https://docs.astral.sh/uv/getting-started/installation/ for details on uv installation.

The following commands install uv and uvx to $HOME/.local/bin. They also modify your bash profile (~/.bashrc) to add this directory to your PATH the next time you start a shell.

curl -LsSf https://astral.sh/uv/install.sh | sh

The uv installer fails to update $HOME/.bashrc for some users; let's make sure this is done.

curl -LsSf https://raw.githubusercontent.com/nhoffman/dawgtools/refs/heads/main/update-bashrc.bash | bash

This command allows you to start using uv immediately; you can also exit and start a new bash shell.

source "$HOME/.local/bin/env"

Once uv is installed, install a recent version of python:

uv python install 3.12

Confirm which python versions are available:

uv python list

Run the uv-managed version of python (uv will choose the most recent version by default):

$ uv run python --version
Python 3.12.8
$ uv run --python 3.9 python --version
Python 3.9.18

See the uv docs for additional options.

dawgtools

Most users should execute commands using uvx from the github repository. This executes the most recent version of the package with all of the necessary dependencies added on the fly. This will take a few seconds the first time; it's faster on subsequent runs.

uvx --from https://github.com/nhoffman/dawgtools.git dawgtools --help

To execute a subcommand, simply include extra arguments:

uvx --from https://github.com/nhoffman/dawgtools.git dawgtools sql2csv -q 'select 1 as col1, 2 as col2'

This should produce the following output:

col1,col2
1,2

For development, run a command from within a cloned version of the repository:

uv run --with-editable . dawgtools --help

Or with a specific python version:

uv run --python 3.12 --with . dawgtools --help

Run tests:

uv run --with-editable . --with pytest pytest