Skip to content

MelissaData/MatchUpObjectGlobal-Python3-Linux

Repository files navigation

Melissa - MatchUp Object Global Linux Python3

Purpose

This code showcases the Melissa MatchUp Object Global using Python3.

Please feel free to copy or embed this code to your own project. Happy coding!

For the latest Melissa MatchUp Object Global release notes, please visit: https://releasenotes.melissa.com/on-premise-api/matchup-object-global/

For further details, please visit: https://docs.melissa.com/on-premise-api/matchup-object-global/matchup-object-global-quickstart.html

The console will ask the user for:

  • A txt file that contains global data you would like to matchup
  • A txt file that contains US data you would like to matchup

And return

  • A txt file of global duplicate groups
  • A txt file of US duplicate groups

Tested Environments

  • Linux 64-bit Python 3.8.7, Ubuntu 20.04.05 LTS
  • Melissa data files for 2024-Q2

Required File(s) and Programs

Binaries

This is the c++ code of the Melissa Object.

  • libmdMatchup.so
  • libmdGlobalParse.so

Data File(s)

  • icudt52l.dat
  • mdMatchup.dat
  • mdMatchup.mc
  • mdMatchup.sac
  • mdMatchup.cfg

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

This project is compatible with Python3

Install Python3

Before starting, make sure that Python3 has been correctly installed on your machine and your environment paths are configured.

You can download Python here: https://www.python.org/downloads/

You can check that your environment is set up correctly by opening a command prompt window and typing the following: python3 --version

alt text

If you see the version number then you have installed Python3 and set up your environment paths correctly!


Download this project

$ git clone https://github.com/MelissaData/MatchUpObjectGlobal-Python3-Linux
$ cd MatchUpObjectGlobal-Python3-Linux

Set up Melissa Updater

Melissa Updater is a CLI application allowing the user to update their Melissa applications/data.

  • In the root directory of the project, create a folder called MelissaUpdater by using the command:

    mkdir MelissaUpdater

  • Enter the newly created folder using the command:

    cd MelissaUpdater

  • Proceed to install the Melissa Updater using the curl command:

    curl -L -O https://releases.melissadata.net/Download/Library/LINUX/NET/ANY/latest/MelissaUpdater

  • After the Melissa Updater is installed, you will need to change the Melissa Updater to an executable using the command:

    chmod +x MelissaUpdater

  • Now that the Melissa Updater is set up, you can now proceed to move back into the project folder by using the command:

    cd ..


Different ways to get data file(s)

  1. Using Melissa Updater
    • It will handle all of the data download/path and .so file(s) for you.
  2. If you already have the latest release zip, you can find the data file(s) in there
    • To pass in your own data file path directory, you may either use the '--dataPath' parameter or enter the data file path directly in interactive mode.
    • Comment out this line "DownloadDataFiles $license" in the bash script.
    • This will prevent you from having to redownload all the files.

Change Bash Script Permissions

To be able to run the bash script, you must first make it an executable using the command:

chmod +x MelissaMatchupObjectGlobalLinuxPython3.sh

Then you need to add permissions to the build directory with the command:

chmod +rwx MelissaMatchupObjectGlobalLinuxPython3

As an indicator, the filename will change colors once it becomes an executable.

You may also need to alter permissions for the python files. To do this navigate into the MelissaMatchupObjectGlobalLinuxPython3 directory and run these commands:
chmod +rx MelissaMatchupObjectGlobalLinuxPython3/MelissaMatchupObjectGlobalLinuxPython3.py
chmod +rx MelissaMatchupObjectGlobalLinuxPython3/mdMatchup_pythoncode.py

Run Bash Script

Parameters:

  • --global: a test global txt file

  • --us: a test US txt file

    These are convenient when you want to get results for specific txt files in one run instead of testing multiple txt files in interactive mode.

  • --dataPath (optional): a data file path directory to test the MatchUp Object Global

  • --license (optional): a license string to test the MatchUp Object Global

  • --quiet (optional): add to the command if you do not want to get any console output from the Melissa Updater

When you have modified the script to match your data location, let's run the script. There are two modes:

  • Interactive

    The script will prompt the user for a txt file, then use the provided txt file to test MatchUp Object Global. For example:

    $ ./MelissaMatchupObjectGlobalLinuxPython3.sh
    

    For quiet mode:

    $ ./MelissaMatchupObjectGlobalLinuxPython3.sh -quiet
    
  • Command Line

    You can pass a global txt file, us txt file, and a license string into the --global, --us, and --license parameters respectively to test MatchUp Object Global. For example:

    $ ./MelissaMatchupObjectGlobalLinuxPython3.sh --global "MelissaMatchupGlobalSampleInput.txt" --us "MelissaMatchupUSSampleInput.txt"
    $ ./MelissaMatchupObjectGlobalLinuxPython3.sh --global "MelissaMatchupGlobalSampleInput.txt" --us "MelissaMatchupUSSampleInput.txt" --license "<your_license_string>"
    

    For quiet mode:

    $ ./MelissaMatchupObjectGlobalLinuxPython3.sh --global "MelissaMatchupGlobalSampleInput.txt" --us "MelissaMatchupUSSampleInput.txt" --quiet
    $ ./MelissaMatchupObjectGlobalLinuxPython3.sh --global "MelissaMatchupGlobalSampleInput.txt" --us "MelissaMatchupUSSampleInput.txt" --license "<your_license_string>" --quiet
    

This is the expected output of a successful setup for interactive mode:

alt text

Troubleshooting

Troubleshooting for errors found while running your program.

Errors:

Error Description
ErrorRequiredFileNotFound Program is missing a required file. Please check your Data folder and refer to the list of required files above. If you are unable to obtain all required files through the Melissa Updater, please contact technical support below.
ErrorLicenseExpired Expired license string. Please contact technical support below.

Contact Us

For free technical support, please call us at 800-MELISSA ext. 4 (800-635-4772 ext. 4) or email us at tech@melissa.com.

To purchase this product, contact the Melissa sales department at 800-MELISSA ext. 3 (800-635-4772 ext. 3).

About

This project shows how to get started with Melissa MatchUp Object Global using Python3 in Linux

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published