Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

New connector for working with the Catalist Match API #912

Merged
merged 10 commits into from
Nov 14, 2023
53 changes: 53 additions & 0 deletions docs/catalist.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
Catalist
=======

********
Overview
********

The CatalistMatch class allows you to interact with the Catalist M Tool (match) API. Users of this Parsons integration can use the Parsons table format to send input files to the M Tool and receive back a matched version of that table.

.. note::
Authentication
In order to use this class you must be provided with an OAuth Client ID and Client Secret from catalist, as well as SFTP credentials. You will also need to have Catalist whitelist the IP address you are using to access the M Tool.

==========
Quickstart
==========

To instantiate the CatalistMatch class, you must provide your ``client_id``, ``client_secret``, ``sftp_username`` and ``sftp_password`` values as arguments:

.. code-block:: sh
# In bash, set your environment variables like so:
$ export CATALIST_CLIENT_ID='MY_UUID'
$ export CATALIST_CLIENT_SECRET='MY_SECRET'
$ export CATALIST_SFTP_USERNAME='MY_USERNAME'
$ export CATALIST_SFTP_PASSWORD='MY_PASSWORD'

.. code-block:: python

import os
from parsons import CatalistMatch

match = CatalistMatch(
client_id=os.environ['CATALIST_CLIENT_ID'],
client_secret=os.environ['CATALIST_CLIENT_SECRET'],
sftp_username=os.environ['CATALIST_SFTP_USERNAME'],
sftp_password=os.environ['CATALIST_SFTP_PASSWORD']
)

You can then load a CSV as a Parsons table and submit it for matching, then save the resulting matched Parsons table as a CSV.

.. code-block:: python

source_table = Table.from_csv(source_filepath)
result_table = match.match(source_table)
result_table.to_csv(result_filepath)


***
API
***

.. autoclass :: parsons.CatalistMatch
:inherited-members:
1 change: 1 addition & 0 deletions parsons/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@
("parsons.box.box", "Box"),
("parsons.braintree.braintree", "Braintree"),
("parsons.capitol_canary.capitol_canary", "CapitolCanary"),
["parsons.catalist.catalist", "CatalistMatch"],
("parsons.civis.civisclient", "CivisClient"),
("parsons.controlshift.controlshift", "Controlshift"),
("parsons.copper.copper", "Copper"),
Expand Down
3 changes: 3 additions & 0 deletions parsons/catalist/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
from parsons.catalist.catalist import CatalistMatch

__all__ = ["CatalistMatch"]
Loading