1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
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
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
|
"""
Copyright (c) 2019 Matthew Lemon
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
IN THE SOFTWARE. """
import logging
import sys
from functools import partial
import click
from click import version_option
from datamaps import __version__
from engine.adapters import cli as engine_cli
from engine.config import Config as engine_config
from engine.exceptions import (DatamapFileEncodingError,
MalFormedCSVHeaderException,
MissingCellKeyError, MissingLineError,
MissingSheetFieldError,
NoApplicableSheetsInTemplateFiles,
RemoveFileWithNoSheetRequiredByDatamap)
logging.basicConfig(level=logging.INFO, format="%(asctime)s: %(levelname)s - %(message)s", datefmt='%d-%b-%y %H:%M:%S')
logger = logging.getLogger(__name__)
be_logger = logging.getLogger("engine.use_cases.parsing")
# we want to pass echo func down to bcompiler-engine
output_funcs = dict(
click_echo_green=partial(click.secho, nl=False, fg="green"),
click_echo_yellow=partial(click.secho, nl=False, fg="yellow"),
click_echo_red=partial(click.secho, nl=False, fg="red"),
click_echo_white=partial(click.secho, nl=False, fg="white"),
)
class Config:
def __init__(self):
self.verbose = False
pass_config = click.make_pass_decorator(Config, ensure=True)
@version_option(__version__)
@click.group()
@click.option("--verbose", is_flag=True)
@pass_config
def cli(config, verbose):
"""
datamaps is a tool for moving data to and from spreadsheets. Documentation available
at https://www.datamaps.twentyfoursoftware.com (comming soon).
Please note: datamaps is beta software! Development is ongoing and the program
is undergoing continuous change.
"""
click.secho(f"Welcome to datamaps {__version__} © Twenty Four Software", fg="yellow")
config.verbose = verbose
engine_config.initialise()
@cli.group("import")
def _import():
"""
Import something (a batch of populated templates, a datamap, etc).
"""
@cli.group("export")
def export():
"""
Export data from one format to another. Current functionality allows for data
to be exported from a Master spreadsheet to one or many blank Templates.
"""
@cli.group("report")
def report():
"""Create a report"""
@_import.command()
@click.option(
"--to-master",
"-m",
is_flag=True,
default=False,
help="Create master.xlsx immediately",
)
def templates(to_master):
if to_master:
try:
engine_cli.import_and_create_master(echo_funcs=output_funcs)
except MalFormedCSVHeaderException as e:
click.echo(
click.style("Incorrect headers in datamap. {}.".format(e.args[0]), bold=True, reverse=True, fg="cyan"))
except RemoveFileWithNoSheetRequiredByDatamap:
logging.info("Import complete.")
except RuntimeError:
logger.critical("Not completing import process due to runtime error. Please check output for CRITICAL messages to diagnose.")
except NoApplicableSheetsInTemplateFiles:
logger.critical("Not completing import process.")
except FileNotFoundError as e:
logger.critical(e)
sys.exit(1)
except MissingSheetFieldError as e:
logger.critical(e)
sys.exit(1)
except MissingCellKeyError as e:
logger.critical(e)
sys.exit(1)
except DatamapFileEncodingError as e:
logger.critical(e)
sys.exit(1)
else:
click.secho("Not implemented yet. Try --to-master/-m flag")
@export.command()
# @click.argument("datamap")
# @click.argument("blank")
@click.argument("master", metavar="FILE_PATH")
def master(master):
"""Export data from a Master file
Export data from master file whose path is FILE_PATH to a series of
blank Template files.
"""
input_dir = engine_config.PLATFORM_DOCS_DIR / "input"
blank_fn = engine_config.config_parser["DEFAULT"]["blank file name"]
datamap_fn = engine_config.config_parser["DEFAULT"]["datamap file name"]
blank = input_dir / blank_fn
datamap = input_dir / datamap_fn
# click.secho(f"EXPORTING master {master} to templates based on {blank}...")
be_logger.info(f"Exporting master {master} to templates based on {blank}.")
try:
engine_cli.write_master_to_templates(blank, datamap, master)
except (FileNotFoundError, RuntimeError) as e:
logger.critical(str(e))
sys.exit(1)
except MissingSheetFieldError as e:
logger.critical(e)
sys.exit(1)
except MissingCellKeyError as e:
logger.critical(e)
sys.exit(1)
except DatamapFileEncodingError as e:
logger.critical(e)
sys.exit(1)
except MissingLineError as e:
logger.critical(e)
sys.exit(1)
be_logger.info("Export complete.")
@report.command()
@click.argument("target_file")
def data_validations(target_file):
"""Requires the path to the target spreadsheet file."""
logger.info(f"Getting data validations from: {target_file}")
try:
report = engine_cli.report_data_validations_in_file(target_file)
except FileNotFoundError as e:
logger.critical(e)
sys.exit(1)
for r in report:
logger.info(r)
@cli.command()
def check():
"""
Checks for a correctly-named blank template in the input directory and
a datamap file in the input directory. Checks for correct headers in datamap.
"""
try:
engine_cli.check_aux_files(engine_config)
except MalFormedCSVHeaderException as e:
logger.critical(e)
sys.exit(1)
except MissingSheetFieldError as e:
logger.critical(e)
sys.exit(1)
except MissingCellKeyError as e:
logger.critical(e)
sys.exit(1)
except DatamapFileEncodingError as e:
logger.critical(e)
sys.exit(1)
except MissingLineError as e:
logger.critical(e)
sys.exit(1)
|
