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/*
4 maintainers
Metadata
4 maintainers
Release files for matchlightsdk 2021.10.14.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| matchlightsdk-2021.10.14.2-py2.py3-none-any.whl | Python 3, Python 2 | none | any | Details |
Release files / matchlightsdk-2021.10.14.2-py2.py3-none-any.whl
| Download URL | matchlightsdk-2021.10.14.2-py2.py3-none-any.whl |
|---|---|
| Size | 871.4 kB |
| Tags | Python 2 Python 3 |
|
SHA-256 checksum How to use checksums |
7bcb2219ea02d797f56fe08b77c8a3e7ebe75b7791c841fe05fb334c589abe53
|
|
BLAKE2b-256 checksum How to use checksums |
9c51c687fd9d1c5d150fc0ad77aba3776da0c8e20387e784e722ccd7c03ac479
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.3.0 pkginfo/1.4.2 requests/2.25.1 setuptools/52.0.0 requests-toolbelt/0.9.1 tqdm/4.57.0 CPython/3.9.5
|
