FourDigits CLI tool

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for fourdigits from gravatar.com fourdigits

Unverified details

These details have not been verified by PyPI
Meta
  • Requires: Python >= 3.9

Project description

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

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"

# We do not yet have a variable to define here, we just define the environment name
[tool.fourdigits.envs.<environment anem>]

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.

Project details

Verified details

These details have been verified by PyPI
Maintainers
Avatar for fourdigits from gravatar.com fourdigits

Unverified details

These details have not been verified by PyPI
Meta
  • Requires: Python >= 3.9

Release history Release notifications | RSS feed

1.17.0

1.16.1

1.16.0

1.15.0

1.14.0

1.13.3

1.13.2

1.13.1

1.13.0

1.12.0

This version

1.11.0

1.10.0

1.9.0

1.8.1

1.8.0

1.7.0

1.6.1

1.6.0

1.5.0

1.4.0

1.3.0

1.2.1

1.2.0

1.1.1

1.1.0

1.0.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

fourdigits-cli-1.11.0.tar.gz (10.1 kB view hashes)

Uploaded Source

Built Distribution

fourdigits_cli-1.11.0-py3-none-any.whl (11.3 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page