matchlightsdk 2021.5.18.1

Software development kit for the Terbium Labs Matchlight product.

Matchlight exists to quickly and privately alert its users when any of their sensitive information appears for sale or vandalism out on the dark web. The product is fully automated, and operates using Data Fingerprints — a one-way representation that allows Terbium to monitor for client data without needing to know what that data is.

The Matchlight SDK provides a Python interface to Matchlight’s API, allowing developers to create and retrieve projects, download feeds, create document, source code, and PII records, and perform searches.

Installation

Matchlight SDK is supported on Python 2.7, 3.3, 3.4, and 3.5. To install the SDK, you’ll need pip:

$ pip install matchlightsdk

Documentation

A walkthrough of the SDK features and API documentation is available at https://python-matchlightsdk.readthedocs.io.

License

The Matchlight Python SDK source code is licensed under the 3-clause BSD License. For more information, please see the LICENSE file included in this repository or source distribution.

Contributing

Bug reports and pull requests are welcome. If you would like to contribute, please create a pull request against master. Include unit tests if necessary, and ensure that your code passes all linters (see tox.ini).

Building

First, install all requirements:

$ make requirements

Then:

$ make build

Tests

To run tests, install test requirements:

$ make dev_requirements

You will also need to install Pyenv https://github.com/pyenv/pyenv#installation The easiest way is with Homebrew:

$ brew update
$ brew install pyenv

NOTE: Make sure that pyenv is added to your path

Then:

$ make test

Update Requirements

If you made a change that adds a new requirement, add it to the correct file in ‘requirements/src’. Then update the requirements file:

$ pip-compile --output-file requirements/<file>.txt requirements/src/<file>.in

Update Documentation

To update the documentation:

$ make docs

To preview changes:

$ make serve docs

Update pypi package

$ python3 setup.py bdist_wheel –universal

$ twine upload dist/*