Skip to content

Jira Initiate Workspace module

Initiate the JIRA workspace.

create_jira_directory(jira_dir)

Create the JIRA directory if it does not exist.

Parameters:

Name Type Description Default
jira_dir str

The JIRA directory.

 required
Source code in jira_python_utils/jira_initiate_workspace.py 
34
35
36
37
38
39
40
41
42
43
44
45
def create_jira_directory(jira_dir: str) -> None:
    """Create the JIRA directory if it does not exist.

    Args:
        jira_dir (str): The JIRA directory.
    """
    if not os.path.exists(jira_dir):
        pathlib.Path(jira_dir).mkdir(parents=True, exist_ok=True)

        console.print(f"Created directory '{jira_dir}'")
    else:
        console.print(f"'{jira_dir}' already exists")

main(jira_id, logfile, outdir)

Initiate the JIRA workspace.

Parameters:

Name Type Description Default
jira_id str

The JIRA ticket identifier.

 required
logfile str

The log file.

 required
outdir str

The output directory.

 required
Source code in jira_python_utils/jira_initiate_workspace.py 
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
@click.command()
@click.option('--jira_id', help='The Jira ticket identifier')
@click.option('--logfile', help="The log file")
@click.option('--outdir', help=f"The default is the current working directory - default is '{DEFAULT_OUTDIR}'")
def main(jira_id: str, logfile: str, outdir: str):
    """Initiate the JIRA workspace.

    Args:
        jira_id (str): The JIRA ticket identifier.
        logfile (str): The log file.
        outdir (str): The output directory.
    """
    error_ctr = 0

    if jira_id is None:
        print_red("--jira_id was not specified")
        error_ctr += 1

    if error_ctr > 0:
        print_red("Required parameter(s) not defined")
        click.echo(click.get_current_context().get_help())
        sys.exit(1)

    if outdir is None:
        outdir = DEFAULT_OUTDIR
        print_yellow(f"--outdir was not specified and therefore was set to '{outdir}'")

    if not os.path.exists(outdir):
        pathlib.Path(outdir).mkdir(parents=True, exist_ok=True)
        print_yellow(f"Created output directory '{outdir}'")

    if logfile is None:
        logfile = os.path.join(
            outdir,
            os.path.splitext(os.path.basename(__file__))[0] + '.log'
        )
        print_yellow(f"--logfile was not specified and therefore was set to '{logfile}'")


    logging.basicConfig(
        filename=logfile,
        format=LOGGING_FORMAT,
        level=LOG_LEVEL
    )

    jira_dir = os.path.join(os.getenv("HOME"), "JIRA", jira_id)
    create_jira_directory(jira_dir)

    shared_jira_dir = os.path.join(os.getenv("HOME"), "vboxshare", "JIRA", jira_id)
    create_jira_directory(shared_jira_dir)