fourdigits-cli 1.13.0

FourDigits CLI tool

FourDigits CLI

A command line tool to make development and deployment easier within Four Digits.

It has the following commands:

1. "docker"
   • "build": Build docker images in our Gitlab CI pipelines
2. "gitlab"
   • "fix-coverage-paths": Change the generated coverage.xml so Gitlab can show coverage visualization in merge requests
3. "exonet"
   • "deploy": Deploy a project to Exonet
   • "db:download": Download a database from Exonet and import it locally
   • "db:copy": Copy a database from one environment to another

Install

pip install fourdigits-cli

Upgrade

pip install --upgrade fourdigits-cli

Enable auto complete

bash

Add this to ~/.bashrc:

eval "$(_FD_COMPLETE=bash_source fd)"
eval "$(_FOURDIGITS_COMPLETE=bash_source fourdigits)"

Zsh

Add this to ~/.zshrc:

eval "$(_FD_COMPLETE=zsh_source fd)"
eval "$(_FOURDIGITS_COMPLETE=zsh_source fourdigits)"

Usage

After installation the cli tool is available under fourdigits and fd. For more information use:

fourdigits --help

Project configuration

The project is configured in the pyproject.toml file, available options and their defaults:

[project]
name = "default-project"

[tool.fourdigits]
exonet_project_name="<default is project name>"
docker_repo="<default is project name>"
slack_channel="<default is project name>"
docker_image_user="fourdigits"

[tool.fourdigits.envs.<environment anem>]
# Every setting can be overridden per environment
slack_channel="custom-channel"

Example project with seperate nextjs

[project]
name = "django-project"

[tool.fourdigits]
# default to project name

[tool.fourdigits.envs.tst]

[tool.fourdigits.envs.acc]

[tool.fourdigits.envs.prd]

[tool.fourdigits.envs.nextjs_tst]
exonet_project_name = "nextjs"
docker_repo = "nextjs"

[tool.fourdigits.envs.nextjs_acc]
exonet_project_name = "nextjs"
docker_repo = "nextjs"

[tool.fourdigits.envs.nextjs_prd]
exonet_project_name = "nextjs"
docker_repo = "nextjs"

Development

make develop

Releasing

To make a new release available on pypi, follow these steps:

1. Update version by edit fourdigits_cli/__init__.py and commit.
2. Run: make push-version
3. Update the installation of fourdigits-cli in https://gitlab.com/fourdigits/utils/docker-pipeline-image/-/blob/main/Dockerfile to the newest version.