Skip to content

Latest commit

 

History

History
211 lines (139 loc) · 5.78 KB

README.md

File metadata and controls

211 lines (139 loc) · 5.78 KB
Raw

Nava PBC Platform CLI

Tooling to make installing, upgrading, and using the Nava Platform easier.

Installation

There are a few ways to get the tool as an end user.

pipx

Install pipx if you haven't. This requires you have a working Python installation of some kind just so pipx can run itself. Things installed via pipx will not depend on the system Python.

Be sure git exists on your $PATH.

Then install the tool with:

pipx install git+ssh://git@github.com/navapbc/platform-cli

You can now run nava-platform.

If you want to get rid of it:

pipx uninstall nava-platform-cli

If it's just a one-off operation and you don't want to install the tool to your $PATH, can use:

pipx run --spec git+ssh://git@github.com/navapbc/platform-cli nava-platform <platform_cli_args>

Nix

Install nix if you haven't. This approach requires nothing else in your environment.

Note, the first time running via nix might take a while building things (as there's no project shared cache setup currently)! But subsequent runs will be faster.

You can install the tool with:

nix profile install --accept-flake-config 'git+ssh://git@github.com/navapbc/platform-cli'

Or for one-off runs:

nix run git+ssh://git@github.com/navapbc/platform-cli -- <platform_cli_args>

You can also run particular branches or version of the tooling with this if needed:

nix run git+ssh://git@github.com/navapbc/platform-cli?ref=my-branch-for-testing-new-thing-before-its-released -- <platform_cli_args>

Alternatively, you can checkout the project locally and in the repository run:

nix run -- <platform_cli_args>

Docker/Containers

Install Docker if you haven't already. Note, Docker is the default for these instructions, but other container runtimes may be similar.

Docker images are not currently published, but eventually may be for releases.

To get a Docker image, clone the repository and run:

make build

bin/docker-wrapper exists to streamline running via Docker, so you can just:

./bin/docker-wrapper infra install ~/my_project_directory

(it can be a little fragile, so treat gently and read about the assumptions it makes in the comments of the script)

Running manually

After building, you will have a nava-platform-cli image locally available that you can run like:

docker run --rm -it nava-platform-cli

For pretty much anything useful, you will need to mount the relevant locations from your host system into the container. For example if running the tool in the directory of your target project:

docker run --rm -it -v "$(pwd):/project-dir" nava-platform-cli infra install /project-dir

(you may want to define some aliases in your shell for commons invocations like this)

Getting Started

After you have nava-platform installed, try

nava-platform infra install --template-uri <path_to_local_copy_of>/template-infra ./just-a-test

to see it in action. Then read the docs for how to apply it to existing projects and more.

Things to be aware of

There are a few limitations or non-obvious things about the behavior of this tool that can cause you to hit issues. For brevity they won't be detailed here, but you can avoid the pitfalls by doing the following:

  1. Always run nava-platform from the root of your project directory
    • For example: nava-platform infra <install/update> <args> . (. as the project argument)
  2. Always pass a relative path as --template-uri one directory up from the project and use the upstream repo name as the directory name for the local checkout of the template
    • For example: nava-platform infra <install/update> --template-uri ../template-infra .

This basically ensures that a consistent set of source paths get saved, with none of them being system-specific, so that things work consistently between CI and local systems.

Shell Completion

You can install completion support for the CLI by running:

nava-platform --install-completion

Or if you want to put the config in a particular location for your shell manually, you need the output from:

nava-platform --show-completion

Development

Setup

For hacking on the tool itself, there are a couple setup options.

Standard

Install poetry >= 1.2.0 if you haven't. The project is not super sensitive to poetry versions, but try to match the version listed at the top of poetry.lock.

Run make deps

Then you can run poetry run nava-platform

Nix

nix develop will drop you into a shell with all dev tooling and python dependencies installed.

You can automate this with direnv.

echo "use flake" > .envrc && direnv allow

But you probably want to use nix-direnv (though there are other options, see the direnv wiki page for Nix). Which the easiest way for that is to simply have your .envrc source in the right version with something like:

if ! has nix_direnv_version || ! nix_direnv_version 3.0.6; then
  source_url "https://raw.githubusercontent.com/nix-community/nix-direnv/3.0.6/direnvrc" "sha256-RYcUJaRMf8oF5LznDrlCXbkOQrywm0HDv1VjYGaJGdM="
fi

use flake

The exact version and hash is probably out of date, refer to the upstream docs for best info.

Process

The project is a standard Python project using poetry for dependency management.

The Makefile has a number of useful commands, see the output of make help.

You may want to consider setting up a pre-commit hook for or just manually running make check before pushing work, as this will run useful checks.