Usage

app

Usage instructions: https://manual.dapla.ssb.no/ssbproject.html

Usage:

 [OPTIONS] COMMAND [ARGS]...

Options:

  --install-completion  Install completion for the current shell.
  --show-completion     Show completion for the current shell, to copy it or
                        customize the installation.

build

:wrench: Create a virtual environment and corresponding Jupyter kernel. Runs in the current folder if no arguments are supplied.

Usage:

 build [OPTIONS] [PATH]

Options:

  [PATH]       Project path
  --no-verify  Verify git configuration files. Use --no-verify to disable
               verification (defaults to True).  \[default: True]
  --no-kernel  Do not install a kernel after the project is built (defaults to
               False).

clean

:broom: Delete the kernel for the given project name.

Usage:

 clean [OPTIONS] PROJECT_NAME

Options:

  PROJECT_NAME  The name of the project/kernel you want to delete.
                \[required]

create

:sparkles: Create a project locally, and optionally on GitHub with the flag --github. The project will follow SSB's best practice for development.

Usage:

 create [OPTIONS] PROJECT_NAME [DESCRIPTION] [REPO_PRIVACY]:[internal|private|public]

Options:

  PROJECT_NAME                    Project name  \[required]
  [DESCRIPTION]                   A short description of your project
  [REPO_PRIVACY]:[internal|private|public]
                                  Visibility of the Github repo  \[default:
                                  internal]
  --github                        Create the repo on Github as well
  --github-token TEXT             Your Github Personal Access Token, follow
                                  these instructions to create one:
                                  https://manual.dapla.ssb.no/git-
                                  github.html#personal-access-token-pat
  --no-verify                     Verify git configuration files. Use --no-
                                  verify to disable verification (defaults to
                                  True).  \[default: True]
  --template-git-url TEXT         The Cookiecutter template URI.  \[default:
                                  https://github.com/statisticsnorway/ssb-
                                  project-template-stat]
  --checkout TEXT                 The git reference to check against. Supports
                                  branches, tags and commit hashes.
  --name TEXT                     Project author's full name.
  --email TEXT                    Project author's email.
  --no-kernel                     Do not create a kernel after the project is
                                  created (defaults to False).