Skip to content

Commit 3e7ff4c

Browse files
dgilmanAIDENTIFIEDdgilmanAIDENTIFIED
authored
Merge pull request #1 from aidentified-llc/delete-fixes
v1.0.0
2 parents e4cfa2f + 06f4465 commit 3e7ff4c

20 files changed

+606
-86
lines changed

‎.github/license_header.txt‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
Copyright 2022 Aidentified LLC
2+
3+
Licensed under the Apache License, Version 2.0 (the "License");
4+
you may not use this file except in compliance with the License.
5+
You may obtain a copy of the License at
6+
7+
http://www.apache.org/licenses/LICENSE-2.0
8+
9+
Unless required by applicable law or agreed to in writing, software
10+
distributed under the License is distributed on an "AS IS" BASIS,
11+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
See the License for the specific language governing permissions and
13+
limitations under the License.

‎.gitignore‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,5 +3,6 @@ venv
33
.idea
44
__pycache__/
55
*.egg-info/
6-
6+
build/
77
*.csv
8+
dist/

‎.pre-commit-config.yaml‎

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,15 +27,23 @@ repos:
2727
hooks:
2828
- id: reorder-python-imports
2929
- repo: https://github.com/psf/black
30-
rev: 21.10b0
30+
rev: 22.1.0
3131
hooks:
3232
- id: black
3333
language_version: python3.9
3434
args: ['-l', '88']
3535
# Run flake8 last, to catch any remaining issues not caught/fixed by
3636
# the other hooks.
3737
- repo: https://gitlab.com/pycqa/flake8
38-
rev: 3.9.2
38+
rev: 4.0.1
3939
hooks:
4040
- id: flake8
4141
exclude: ^manage.py$
42+
- repo: https://github.com/Lucas-C/pre-commit-hooks
43+
rev: v1.1.10
44+
hooks:
45+
- id: insert-license
46+
files: \.py$
47+
args:
48+
- --license-filepath
49+
- .github/license_header.txt

‎LICENSE‎

Lines changed: 202 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,202 @@
1+
2+
Apache License
3+
Version 2.0, January 2004
4+
http://www.apache.org/licenses/
5+
6+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7+
8+
1. Definitions.
9+
10+
"License" shall mean the terms and conditions for use, reproduction,
11+
and distribution as defined by Sections 1 through 9 of this document.
12+
13+
"Licensor" shall mean the copyright owner or entity authorized by
14+
the copyright owner that is granting the License.
15+
16+
"Legal Entity" shall mean the union of the acting entity and all
17+
other entities that control, are controlled by, or are under common
18+
control with that entity. For the purposes of this definition,
19+
"control" means (i) the power, direct or indirect, to cause the
20+
direction or management of such entity, whether by contract or
21+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
22+
outstanding shares, or (iii) beneficial ownership of such entity.
23+
24+
"You" (or "Your") shall mean an individual or Legal Entity
25+
exercising permissions granted by this License.
26+
27+
"Source" form shall mean the preferred form for making modifications,
28+
including but not limited to software source code, documentation
29+
source, and configuration files.
30+
31+
"Object" form shall mean any form resulting from mechanical
32+
transformation or translation of a Source form, including but
33+
not limited to compiled object code, generated documentation,
34+
and conversions to other media types.
35+
36+
"Work" shall mean the work of authorship, whether in Source or
37+
Object form, made available under the License, as indicated by a
38+
copyright notice that is included in or attached to the work
39+
(an example is provided in the Appendix below).
40+
41+
"Derivative Works" shall mean any work, whether in Source or Object
42+
form, that is based on (or derived from) the Work and for which the
43+
editorial revisions, annotations, elaborations, or other modifications
44+
represent, as a whole, an original work of authorship. For the purposes
45+
of this License, Derivative Works shall not include works that remain
46+
separable from, or merely link (or bind by name) to the interfaces of,
47+
the Work and Derivative Works thereof.
48+
49+
"Contribution" shall mean any work of authorship, including
50+
the original version of the Work and any modifications or additions
51+
to that Work or Derivative Works thereof, that is intentionally
52+
submitted to Licensor for inclusion in the Work by the copyright owner
53+
or by an individual or Legal Entity authorized to submit on behalf of
54+
the copyright owner. For the purposes of this definition, "submitted"
55+
means any form of electronic, verbal, or written communication sent
56+
to the Licensor or its representatives, including but not limited to
57+
communication on electronic mailing lists, source code control systems,
58+
and issue tracking systems that are managed by, or on behalf of, the
59+
Licensor for the purpose of discussing and improving the Work, but
60+
excluding communication that is conspicuously marked or otherwise
61+
designated in writing by the copyright owner as "Not a Contribution."
62+
63+
"Contributor" shall mean Licensor and any individual or Legal Entity
64+
on behalf of whom a Contribution has been received by Licensor and
65+
subsequently incorporated within the Work.
66+
67+
2. Grant of Copyright License. Subject to the terms and conditions of
68+
this License, each Contributor hereby grants to You a perpetual,
69+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70+
copyright license to reproduce, prepare Derivative Works of,
71+
publicly display, publicly perform, sublicense, and distribute the
72+
Work and such Derivative Works in Source or Object form.
73+
74+
3. Grant of Patent License. Subject to the terms and conditions of
75+
this License, each Contributor hereby grants to You a perpetual,
76+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77+
(except as stated in this section) patent license to make, have made,
78+
use, offer to sell, sell, import, and otherwise transfer the Work,
79+
where such license applies only to those patent claims licensable
80+
by such Contributor that are necessarily infringed by their
81+
Contribution(s) alone or by combination of their Contribution(s)
82+
with the Work to which such Contribution(s) was submitted. If You
83+
institute patent litigation against any entity (including a
84+
cross-claim or counterclaim in a lawsuit) alleging that the Work
85+
or a Contribution incorporated within the Work constitutes direct
86+
or contributory patent infringement, then any patent licenses
87+
granted to You under this License for that Work shall terminate
88+
as of the date such litigation is filed.
89+
90+
4. Redistribution. You may reproduce and distribute copies of the
91+
Work or Derivative Works thereof in any medium, with or without
92+
modifications, and in Source or Object form, provided that You
93+
meet the following conditions:
94+
95+
(a) You must give any other recipients of the Work or
96+
Derivative Works a copy of this License; and
97+
98+
(b) You must cause any modified files to carry prominent notices
99+
stating that You changed the files; and
100+
101+
(c) You must retain, in the Source form of any Derivative Works
102+
that You distribute, all copyright, patent, trademark, and
103+
attribution notices from the Source form of the Work,
104+
excluding those notices that do not pertain to any part of
105+
the Derivative Works; and
106+
107+
(d) If the Work includes a "NOTICE" text file as part of its
108+
distribution, then any Derivative Works that You distribute must
109+
include a readable copy of the attribution notices contained
110+
within such NOTICE file, excluding those notices that do not
111+
pertain to any part of the Derivative Works, in at least one
112+
of the following places: within a NOTICE text file distributed
113+
as part of the Derivative Works; within the Source form or
114+
documentation, if provided along with the Derivative Works; or,
115+
within a display generated by the Derivative Works, if and
116+
wherever such third-party notices normally appear. The contents
117+
of the NOTICE file are for informational purposes only and
118+
do not modify the License. You may add Your own attribution
119+
notices within Derivative Works that You distribute, alongside
120+
or as an addendum to the NOTICE text from the Work, provided
121+
that such additional attribution notices cannot be construed
122+
as modifying the License.
123+
124+
You may add Your own copyright statement to Your modifications and
125+
may provide additional or different license terms and conditions
126+
for use, reproduction, or distribution of Your modifications, or
127+
for any such Derivative Works as a whole, provided Your use,
128+
reproduction, and distribution of the Work otherwise complies with
129+
the conditions stated in this License.
130+
131+
5. Submission of Contributions. Unless You explicitly state otherwise,
132+
any Contribution intentionally submitted for inclusion in the Work
133+
by You to the Licensor shall be under the terms and conditions of
134+
this License, without any additional terms or conditions.
135+
Notwithstanding the above, nothing herein shall supersede or modify
136+
the terms of any separate license agreement you may have executed
137+
with Licensor regarding such Contributions.
138+
139+
6. Trademarks. This License does not grant permission to use the trade
140+
names, trademarks, service marks, or product names of the Licensor,
141+
except as required for reasonable and customary use in describing the
142+
origin of the Work and reproducing the content of the NOTICE file.
143+
144+
7. Disclaimer of Warranty. Unless required by applicable law or
145+
agreed to in writing, Licensor provides the Work (and each
146+
Contributor provides its Contributions) on an "AS IS" BASIS,
147+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148+
implied, including, without limitation, any warranties or conditions
149+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150+
PARTICULAR PURPOSE. You are solely responsible for determining the
151+
appropriateness of using or redistributing the Work and assume any
152+
risks associated with Your exercise of permissions under this License.
153+
154+
8. Limitation of Liability. In no event and under no legal theory,
155+
whether in tort (including negligence), contract, or otherwise,
156+
unless required by applicable law (such as deliberate and grossly
157+
negligent acts) or agreed to in writing, shall any Contributor be
158+
liable to You for damages, including any direct, indirect, special,
159+
incidental, or consequential damages of any character arising as a
160+
result of this License or out of the use or inability to use the
161+
Work (including but not limited to damages for loss of goodwill,
162+
work stoppage, computer failure or malfunction, or any and all
163+
other commercial damages or losses), even if such Contributor
164+
has been advised of the possibility of such damages.
165+
166+
9. Accepting Warranty or Additional Liability. While redistributing
167+
the Work or Derivative Works thereof, You may choose to offer,
168+
and charge a fee for, acceptance of support, warranty, indemnity,
169+
or other liability obligations and/or rights consistent with this
170+
License. However, in accepting such obligations, You may act only
171+
on Your own behalf and on Your sole responsibility, not on behalf
172+
of any other Contributor, and only if You agree to indemnify,
173+
defend, and hold each Contributor harmless for any liability
174+
incurred by, or claims asserted against, such Contributor by reason
175+
of your accepting any such warranty or additional liability.
176+
177+
END OF TERMS AND CONDITIONS
178+
179+
APPENDIX: How to apply the Apache License to your work.
180+
181+
To apply the Apache License to your work, attach the following
182+
boilerplate notice, with the fields enclosed by brackets "[]"
183+
replaced with your own identifying information. (Don't include
184+
the brackets!) The text should be enclosed in the appropriate
185+
comment syntax for the file format. We also recommend that a
186+
file or class name and description of purpose be included on the
187+
same "printed page" as the copyright notice for easier
188+
identification within third-party archives.
189+
190+
Copyright [yyyy] [name of copyright owner]
191+
192+
Licensed under the Apache License, Version 2.0 (the "License");
193+
you may not use this file except in compliance with the License.
194+
You may obtain a copy of the License at
195+
196+
http://www.apache.org/licenses/LICENSE-2.0
197+
198+
Unless required by applicable law or agreed to in writing, software
199+
distributed under the License is distributed on an "AS IS" BASIS,
200+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201+
See the License for the specific language governing permissions and
202+
limitations under the License.

‎MANIFEST.in‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
include requirements.in

‎README.md‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ This is a command-line wrapper around Aidentified's bulk contact matching API. I
33
matching this is the easiest way to get up and running with Aidentified.
44

55
## Installation
6-
Requirements: Python 3.6
6+
Requirements: Python 3.6+
77

88
To install in your system Python environment:
99

@@ -28,8 +28,8 @@ attributes for your contacts you must download the `delta` files, which are pro
2828
`dataset-file`. The `delta` file only contains the records of contacts whose attributes have changed in the
2929
Aidentified system.
3030

31-
There is also a nightly `event` file produced for each `dataset-file` that lists the most recent Money in Motion events
32-
for each matched contact. These files are returned in a CSV format.
31+
There is also a nightly `trigger` file produced for each `dataset-file` that lists the most recent Money in Motion
32+
events for each matched contact. These files are returned in a CSV format.
3333

3434
The `dataset-file` follows a state machine through its matching process. The current state is available as the `status`
3535
field in the objects written to stdout by the `dataset-file list` subcommand. As an example:
@@ -60,7 +60,7 @@ return to `UPLOAD_NOT_STARTED` from here as `dataset-file`s are immutable.
6060
* MATCHING_ERROR: The Aidentified matcher was unable to complete the initial matching. An error message is available
6161
in the output of `dataset-file list`.
6262
* MATCHING_FINISHED: The initial matching of the `dataset-file` is complete and the fully-matched file is available
63-
for download. The system will also start producing nightly delta and event files.
63+
for download. The system will also start producing nightly delta and trigger files.
6464

6565
## Usage
6666
The `aidentifed_match` CLI program has extensive help for all of its functionality. Adding `--help` to any of its
@@ -169,16 +169,16 @@ aidentified_match dataset-file delta download --dataset-name DATASET_NAME --data
169169
Download a nightly delta file for dataset-file `DATASET_FILE_NAME` and date `FILE_DATE` to the `DATASET_FILE_PATH` location,
170170
creating a new file if one does not exist and truncating any existing files. Delta files are CSV files.
171171

172-
### dataset-file event list
172+
### dataset-file trigger list
173173
```shell
174-
aidentified_match dataset-file event list --dataset-name DATASET_NAME --dataset-file-name DATASET_FILE_NAME
174+
aidentified_match dataset-file trigger list --dataset-name DATASET_NAME --dataset-file-name DATASET_FILE_NAME
175175
```
176-
List any nightly event files that exist for the given dataset-file.
176+
List any nightly trigger files that exist for the given dataset-file.
177177

178-
### dataset-file event download
178+
### dataset-file trigger download
179179
```shell
180-
aidentified_match dataset-file event download --dataset-name DATASET_NAME --dataset-file-name DATASET_FILE_NAME
180+
aidentified_match dataset-file trigger download --dataset-name DATASET_NAME --dataset-file-name DATASET_FILE_NAME
181181
--dataset-file-path DATASET_FILE_PATH --file-date FILE_DATE
182182
```
183-
Download a nightly event file for dataset-file `DATASET_FILE_NAME` and date `FILE_DATE` to the `DATASET_FILE_PATH` location,
184-
creating a new file if one does not exist and truncating any existing files. Event files are CSV files.
183+
Download a nightly trigger file for dataset-file `DATASET_FILE_NAME` and date `FILE_DATE` to the `DATASET_FILE_PATH`
184+
location, creating a new file if one does not exist and truncating any existing files. Trigger files are CSV files.

‎aidentified_matching_api/__init__.py‎

Lines changed: 25 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,17 @@
11
# -*- coding: utf-8 -*-
2+
# Copyright 2022 Aidentified LLC
3+
#
4+
# Licensed under the Apache License, Version 2.0 (the "License");
5+
# you may not use this file except in compliance with the License.
6+
# You may obtain a copy of the License at
7+
#
8+
# http://www.apache.org/licenses/LICENSE-2.0
9+
#
10+
# Unless required by applicable law or agreed to in writing, software
11+
# distributed under the License is distributed on an "AS IS" BASIS,
12+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
# See the License for the specific language governing permissions and
14+
# limitations under the License.
215
import argparse
316
import csv
417
import datetime
@@ -268,31 +281,33 @@ def _get_dataset_file_parent(
268281
dataset_file_delta_download.set_defaults(func=daily_files.download_dataset_file_delta)
269282

270283
#
271-
# dataset-file event list/download
284+
# dataset-file trigger list/download
272285
#
273286

274-
dataset_file_event_parser = dataset_files_subparser.add_parser(
275-
"event", help="Manage dataset event files"
287+
dataset_file_trigger_parser = dataset_files_subparser.add_parser(
288+
"trigger", help="Manage dataset trigger files"
276289
)
277-
dataset_file_event_subparser = dataset_file_event_parser.add_subparsers()
290+
dataset_file_trigger_subparser = dataset_file_trigger_parser.add_subparsers()
278291

279-
dataset_file_event_list = dataset_file_event_subparser.add_parser(
292+
dataset_file_trigger_list = dataset_file_trigger_subparser.add_parser(
280293
"list",
281-
help="List dataset event files",
294+
help="List dataset trigger files",
282295
parents=[_get_dataset_file_parent(dataset_file_name=True)],
283296
)
284-
dataset_file_event_list.set_defaults(func=daily_files.list_dataset_event_files)
297+
dataset_file_trigger_list.set_defaults(func=daily_files.list_dataset_trigger_files)
285298

286-
dataset_file_event_download = dataset_file_event_subparser.add_parser(
299+
dataset_file_trigger_download = dataset_file_trigger_subparser.add_parser(
287300
"download",
288-
help="Download a dataset event file",
301+
help="Download a dataset trigger file",
289302
parents=[
290303
_get_dataset_file_parent(
291304
dataset_file_name=True, dataset_file_download=True, file_date=True
292305
)
293306
],
294307
)
295-
dataset_file_event_download.set_defaults(func=daily_files.download_dataset_event_file)
308+
dataset_file_trigger_download.set_defaults(
309+
func=daily_files.download_dataset_trigger_file
310+
)
296311

297312

298313
def main():

‎aidentified_matching_api/constants.py‎

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,22 @@
11
# -*- coding: utf-8 -*-
2+
# Copyright 2022 Aidentified LLC
3+
#
4+
# Licensed under the Apache License, Version 2.0 (the "License");
5+
# you may not use this file except in compliance with the License.
6+
# You may obtain a copy of the License at
7+
#
8+
# http://www.apache.org/licenses/LICENSE-2.0
9+
#
10+
# Unless required by applicable law or agreed to in writing, software
11+
# distributed under the License is distributed on an "AS IS" BASIS,
12+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
# See the License for the specific language governing permissions and
14+
# limitations under the License.
215
import json
316
import os
417

518
AIDENTIFIED_URL = os.environ.get(
6-
"AIDENTIFIED_URL", "https://enterprise-matching-api.aidentified.com"
19+
"AIDENTIFIED_URL", "https://matching-api.aidentified.com"
720
)
821

922

0 commit comments

Comments
 (0)