adelgado/find_duplicate_contacts
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add readme

Browse source
This commit is contained in:
Antonio J. Delgado 2022-06-13 22:21:15 +03:00
parent 96a33b3a6e
commit 8488ecc03b
2 changed files with 21 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
README.md
View file

@ -2,6 +2,9 @@
## Requirements ## Requirements
See the requirements.txt file for required Python modules.
Save the contacts as individual (one contact per file) vCard files in an isolated directory.
## Installation ## Installation
### Linux ### Linux
@ -13,5 +16,21 @@
`& $(where.exe python).split()[0] setup.py install` `& $(where.exe python).split()[0] setup.py install`
## Usage ## Usage
- Save the contacts as individual (one contact per file) vCard files in an isolated directory, pass this directory with the *--directory* option.
- Those completely equal, except for some list of keys (see the *ignore_fileds* variable), will be directly moved to the *--duplicates-destination* folder inside the *--directory*.
- Those with equal full name, will be show and a prompt will ask you to keep one of the contact cards or just do nothing with them.
`find_duplicate_contacts.py [--debug-level|-d CRITICAL|ERROR|WARNING|INFO|DEBUG|NOTSET] # Other parameters` ```
find_duplicate_contacts.py [OPTIONS]
Options:
-d, --debug-level [CRITICAL|ERROR|WARNING|INFO|DEBUG|NOTSET]
Set the debug level for the standard output.
-l, --log-file TEXT File to store all debug messages.
-f, --directory TEXT Directory containing vCard files to check.
[required]
-D, --duplicates-destination TEXT
Directory to move duplicates files, relative
to the directory containing the vCards. Default: duplicates
--config FILE Read configuration from FILE.
--help Show this message and exit.```

2
find_duplicate_contacts/find_duplicate_contacts.py
View file

@ -207,7 +207,7 @@ class find_duplicate_contacts:
case_sensitive=False, case_sensitive=False,
), help='Set the debug level for the standard output.') ), help='Set the debug level for the standard output.')
@click.option('--log-file', '-l', help="File to store all debug messages.") @click.option('--log-file', '-l', help="File to store all debug messages.")
@click.option("--directory", "-d", help="Directory containing vCard files to check.") @click.option("--directory", "-f", required=True, help="Directory containing vCard files to check.")
@click.option('--duplicates-destination', '-D', default='duplicates', help='Directory to move duplicates files, relative to the directory containing the vCards.') @click.option('--duplicates-destination', '-D', default='duplicates', help='Directory to move duplicates files, relative to the directory containing the vCards.')
@click_config_file.configuration_option() @click_config_file.configuration_option()
def __main__(debug_level, log_file, directory, duplicates_destination): def __main__(debug_level, log_file, directory, duplicates_destination):