million-verifier-client 0.1.2

No project description provided

Million Verifier Python Client

Python client for Million Verifier. API documentation can be found here.

Setup

It is advised that million-verifier-client is installed within a virtual environment (e.g., Poetry, venv, etc.). Once in an activated virtual environment, million-verifier-client can be installed with the following commands:

Pip:

pip install million-verifier-client

Poetry:

poetry add million-verifier-client

Example Usage

import os
from million_verifier import MillionVerifierClient

client = MillionVerifierClient(
    api_key=os.getenv("MILLION_VERIFIER_API_KEY"),
)

client.list_files()

Output:

{
  "files": [
    {
      "file_id": 25645547490,
      "file_name": "test-emails-1.txt",
      "status": "finished",
      "unique_emails": 0,
      "updated_at": "2023-11-25 12:12:21",
      "createdate": "2023-11-25 12:12:16",
      "percent": 100,
      "total_rows": 10,
      "verified": 9,
      "unverified": 1,
      "ok": 8,
      "catch_all": 0,
      "disposable": 0,
      "invalid": 1,
      "unknown": 0,
      "reverify": 0,
      "credit": 10,
      "estimated_time_sec": 0,
      "error": ""
    }
  ], 
  "total": 1
}

Development

Testing

Tests can be run using Pytest:

pytest

Or, using Pytest within a Poetry environment:

poetry run pytest

In order to run tests successfully, make sure you have a valid API key declared as a MILLION_VERIFIER_API_KEY environment variable. This can be done by adding a .env.local file to the root directory of this project:

MILLION_VERIFIER_API_KEY="<YOUR_API_KEY>"