revenuebase-sdk 0.1.0__tar.gz

revenuebase_sdk-0.1.0/.gitignore

@@ -0,0 +1,43 @@
+# Python
+__pycache__/
+*.py[cod]
+*.pyo
+*.pyd
+*.egg-info/
+*.egg
+.eggs/
+
+# Build / dist
+dist/
+build/
+*.whl
+*.tar.gz
+
+# Environments
+.env
+.env.*
+.venv/
+venv/
+env/
+
+# Type checking / linting
+.mypy_cache/
+.ruff_cache/
+
+# Testing
+.pytest_cache/
+.coverage
+htmlcov/
+
+# IDE
+.vscode/
+.idea/
+*.swp
+*.swo
+
+# macOS
+.DS_Store
+
+# Local scratch / manual test scripts
+scratch.py
+scratch_*.py

revenuebase_sdk-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Revenuebase
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

revenuebase_sdk-0.1.0/PKG-INFO

@@ -0,0 +1,207 @@
+Metadata-Version: 2.4
+Name: revenuebase-sdk
+Version: 0.1.0
+Summary: Python SDK for the Revenuebase Email Verification and Company Resolver API.
+Project-URL: Homepage, https://revenuebase.ai
+Project-URL: Documentation, https://docs.revenuebase.ai
+Project-URL: Repository, https://github.com/revenuebase/revenuebase-sdk
+Project-URL: Bug Tracker, https://github.com/revenuebase/revenuebase-sdk/issues
+Project-URL: Changelog, https://github.com/revenuebase/revenuebase-sdk/blob/main/CHANGELOG.md
+License: MIT
+License-File: LICENSE
+Keywords: api,email,revenuebase,sdk,validation
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Typing :: Typed
+Requires-Python: >=3.8
+Requires-Dist: httpx>=0.24.0
+Requires-Dist: pydantic>=2.0.0
+Provides-Extra: dev
+Requires-Dist: build>=1.0; extra == 'dev'
+Requires-Dist: mypy>=1.0; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.21; extra == 'dev'
+Requires-Dist: pytest>=7.0; extra == 'dev'
+Requires-Dist: respx>=0.20; extra == 'dev'
+Requires-Dist: ruff>=0.4.0; extra == 'dev'
+Requires-Dist: twine>=5.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# Revenuebase Python SDK
+
+Python SDK for the [Revenuebase API](https://api.revenuebase.ai) — email validation and company resolution.
+
+## Requirements
+
+- Python ≥ 3.8
+
+## Install
+
+```bash
+pip install revenuebase-sdk
+```
+
+## Quickstart
+
+```python
+from revenuebase_sdk import RevenuebaseClient
+
+client = RevenuebaseClient(api_key="your-api-key")
+# Or set REVENUEBASE_API_KEY in your environment and call RevenuebaseClient()
+
+# Validate a single email
+result = client.email_processing.validate_email(email="user@acme.com")
+print(result.status)  # "Valid", "Invalid", or "Unknown"
+
+# With full metadata
+result = client.email_processing.validate_email(email="user@acme.com", metadata=True)
+print(result.mx_record_present, result.email_provider)
+
+# Check your credit balance
+credits = client.user_operations.get_credits()
+print(credits.credits)
+```
+
+## Authentication
+
+Pass your API key via the `api_key` parameter or the `REVENUEBASE_API_KEY` environment variable. The key is sent as the `x-key` header on every request.
+
+```bash
+export REVENUEBASE_API_KEY="your-api-key"
+```
+
+## Resources
+
+### `email_processing`
+
+| Method | Description |
+|---|---|
+| `validate_email(*, email, metadata=False)` | Validate a single email. Returns `Valid`, `Invalid`, or `Unknown`. |
+| `batch_upload(*, file, filename, metadata=False)` | Upload a `.csv` or `.json` file for async batch validation. |
+| `get_batch_status(*, process_id)` | Poll the status of a batch job. |
+| `list_queued()` | List all active (queued or processing) batch jobs. |
+| `cancel_batch(*, process_id)` | Cancel a queued or in-progress batch job. |
+| `download_batch(*, process_id)` | Download the results of a completed job as bytes. |
+| `batch_start(*, filename, metadata=False)` | *(Deprecated)* Queue a pre-uploaded file. Use `batch_upload` instead. |
+
+### `user_operations`
+
+| Method | Description |
+|---|---|
+| `get_credits()` | Get your remaining credit balance. |
+| `rotate_api_key()` | Generate a new API key (invalidates the previous one immediately). |
+
+### `company_resolver`
+
+| Method | Description |
+|---|---|
+| `resolve(*, company_name, result_count=3, ...)` | Match a company name to verified records using semantic search. |
+| `discover(*, keyword, result_count=1000, ...)` | Discover companies matching a keyword or description. |
+
+## Batch validation workflow
+
+```python
+import time
+
+# 1. Upload the file
+with open("emails.csv", "rb") as f:
+    job = client.email_processing.batch_upload(file=f, filename="emails.csv")
+
+print(f"Job {job.process_id} queued")
+
+# 2. Poll until complete
+while True:
+    status = client.email_processing.get_batch_status(process_id=job.process_id)
+    print(status.current_status)
+    if status.current_status in ("COMPLETED", "ERROR", "CANCELLED"):
+        break
+    time.sleep(5)
+
+# 3. Download results
+if status.current_status == "COMPLETED":
+    data = client.email_processing.download_batch(process_id=job.process_id)
+    with open("results.csv", "wb") as f:
+        f.write(data)
+```
+
+## Company resolution
+
+```python
+# Match by name
+result = client.company_resolver.resolve(
+    company_name="Stripe",
+    result_count=3,
+    headquarters_country="US",
+)
+for company in result.companies:
+    print(company.company_name, company.similar_score, company.headquarters_city)
+
+# Discover by keyword
+result = client.company_resolver.discover(
+    keyword="enterprise cybersecurity SaaS",
+    result_count=100,
+    headquarters_country="US",
+)
+```
+
+## Async usage
+
+```python
+import asyncio
+from revenuebase_sdk import AsyncRevenuebaseClient
+
+async def main():
+    async with AsyncRevenuebaseClient(api_key="your-api-key") as client:
+        result = await client.email_processing.validate_email(email="user@acme.com")
+        print(result.status)
+
+asyncio.run(main())
+```
+
+## Error handling
+
+```python
+from revenuebase_sdk import (
+    AuthenticationError,
+    BadRequestError,
+    RateLimitError,
+    APIConnectionError,
+)
+
+try:
+    result = client.email_processing.validate_email(email="user@acme.com")
+except AuthenticationError:
+    print("Invalid API key")
+except BadRequestError as e:
+    print(f"Bad request: {e.message}")
+except RateLimitError:
+    print("Rate limited — slow down requests")
+except APIConnectionError as e:
+    print(f"Network error: {e.message}")
+```
+
+## Per-request options
+
+```python
+# Override timeout for a single call
+result = (
+    client
+    .with_options(timeout=5.0, max_retries=0)
+    .email_processing.validate_email(email="user@acme.com")
+)
+```
+
+## Development
+
+```bash
+pip install -e ".[dev]"
+pytest
+mypy src
+ruff check src
+```

revenuebase_sdk-0.1.0/README.md

@@ -0,0 +1,172 @@
+# Revenuebase Python SDK
+
+Python SDK for the [Revenuebase API](https://api.revenuebase.ai) — email validation and company resolution.
+
+## Requirements
+
+- Python ≥ 3.8
+
+## Install
+
+```bash
+pip install revenuebase-sdk
+```
+
+## Quickstart
+
+```python
+from revenuebase_sdk import RevenuebaseClient
+
+client = RevenuebaseClient(api_key="your-api-key")
+# Or set REVENUEBASE_API_KEY in your environment and call RevenuebaseClient()
+
+# Validate a single email
+result = client.email_processing.validate_email(email="user@acme.com")
+print(result.status)  # "Valid", "Invalid", or "Unknown"
+
+# With full metadata
+result = client.email_processing.validate_email(email="user@acme.com", metadata=True)
+print(result.mx_record_present, result.email_provider)
+
+# Check your credit balance
+credits = client.user_operations.get_credits()
+print(credits.credits)
+```
+
+## Authentication
+
+Pass your API key via the `api_key` parameter or the `REVENUEBASE_API_KEY` environment variable. The key is sent as the `x-key` header on every request.
+
+```bash
+export REVENUEBASE_API_KEY="your-api-key"
+```
+
+## Resources
+
+### `email_processing`
+
+| Method | Description |
+|---|---|
+| `validate_email(*, email, metadata=False)` | Validate a single email. Returns `Valid`, `Invalid`, or `Unknown`. |
+| `batch_upload(*, file, filename, metadata=False)` | Upload a `.csv` or `.json` file for async batch validation. |
+| `get_batch_status(*, process_id)` | Poll the status of a batch job. |
+| `list_queued()` | List all active (queued or processing) batch jobs. |
+| `cancel_batch(*, process_id)` | Cancel a queued or in-progress batch job. |
+| `download_batch(*, process_id)` | Download the results of a completed job as bytes. |
+| `batch_start(*, filename, metadata=False)` | *(Deprecated)* Queue a pre-uploaded file. Use `batch_upload` instead. |
+
+### `user_operations`
+
+| Method | Description |
+|---|---|
+| `get_credits()` | Get your remaining credit balance. |
+| `rotate_api_key()` | Generate a new API key (invalidates the previous one immediately). |
+
+### `company_resolver`
+
+| Method | Description |
+|---|---|
+| `resolve(*, company_name, result_count=3, ...)` | Match a company name to verified records using semantic search. |
+| `discover(*, keyword, result_count=1000, ...)` | Discover companies matching a keyword or description. |
+
+## Batch validation workflow
+
+```python
+import time
+
+# 1. Upload the file
+with open("emails.csv", "rb") as f:
+    job = client.email_processing.batch_upload(file=f, filename="emails.csv")
+
+print(f"Job {job.process_id} queued")
+
+# 2. Poll until complete
+while True:
+    status = client.email_processing.get_batch_status(process_id=job.process_id)
+    print(status.current_status)
+    if status.current_status in ("COMPLETED", "ERROR", "CANCELLED"):
+        break
+    time.sleep(5)
+
+# 3. Download results
+if status.current_status == "COMPLETED":
+    data = client.email_processing.download_batch(process_id=job.process_id)
+    with open("results.csv", "wb") as f:
+        f.write(data)
+```
+
+## Company resolution
+
+```python
+# Match by name
+result = client.company_resolver.resolve(
+    company_name="Stripe",
+    result_count=3,
+    headquarters_country="US",
+)
+for company in result.companies:
+    print(company.company_name, company.similar_score, company.headquarters_city)
+
+# Discover by keyword
+result = client.company_resolver.discover(
+    keyword="enterprise cybersecurity SaaS",
+    result_count=100,
+    headquarters_country="US",
+)
+```
+
+## Async usage
+
+```python
+import asyncio
+from revenuebase_sdk import AsyncRevenuebaseClient
+
+async def main():
+    async with AsyncRevenuebaseClient(api_key="your-api-key") as client:
+        result = await client.email_processing.validate_email(email="user@acme.com")
+        print(result.status)
+
+asyncio.run(main())
+```
+
+## Error handling
+
+```python
+from revenuebase_sdk import (
+    AuthenticationError,
+    BadRequestError,
+    RateLimitError,
+    APIConnectionError,
+)
+
+try:
+    result = client.email_processing.validate_email(email="user@acme.com")
+except AuthenticationError:
+    print("Invalid API key")
+except BadRequestError as e:
+    print(f"Bad request: {e.message}")
+except RateLimitError:
+    print("Rate limited — slow down requests")
+except APIConnectionError as e:
+    print(f"Network error: {e.message}")
+```
+
+## Per-request options
+
+```python
+# Override timeout for a single call
+result = (
+    client
+    .with_options(timeout=5.0, max_retries=0)
+    .email_processing.validate_email(email="user@acme.com")
+)
+```
+
+## Development
+
+```bash
+pip install -e ".[dev]"
+pytest
+mypy src
+ruff check src
+```

revenuebase_sdk-0.1.0/pyproject.toml

@@ -0,0 +1,77 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "revenuebase-sdk"
+dynamic = ["version"]
+description = "Python SDK for the Revenuebase Email Verification and Company Resolver API."
+readme = "README.md"
+requires-python = ">=3.8"
+license = { text = "MIT" }
+keywords = ["api", "sdk", "email", "validation", "revenuebase"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Typing :: Typed",
+]
+dependencies = [
+    "httpx>=0.24.0",
+    "pydantic>=2.0.0",
+]
+
+[project.urls]
+Homepage = "https://revenuebase.ai"
+Documentation = "https://docs.revenuebase.ai"
+Repository = "https://github.com/revenuebase/revenuebase-sdk"
+"Bug Tracker" = "https://github.com/revenuebase/revenuebase-sdk/issues"
+Changelog = "https://github.com/revenuebase/revenuebase-sdk/blob/main/CHANGELOG.md"
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=7.0",
+    "pytest-asyncio>=0.21",
+    "respx>=0.20",
+    "mypy>=1.0",
+    "ruff>=0.4.0",
+    "build>=1.0",
+    "twine>=5.0",
+]
+
+[tool.hatch.version]
+path = "src/revenuebase_sdk/_version.py"
+pattern = '__version__ = "(?P<version>[^"]+)"'
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/revenuebase_sdk"]
+exclude = ["src/revenuebase_sdk/snowflake"]
+
+[tool.hatch.build.targets.sdist]
+include = ["src/revenuebase_sdk/**", "tests/**", "README.md"]
+
+[tool.pytest.ini_options]
+asyncio_mode = "auto"
+testpaths = ["tests"]
+
+[tool.mypy]
+strict = true
+files = ["src"]
+python_version = "3.8"
+
+[tool.ruff]
+target-version = "py38"
+line-length = 100
+
+[tool.ruff.lint]
+select = ["E", "F", "I", "UP", "B", "SIM"]
+ignore = ["E501"]
+
+[tool.ruff.lint.isort]
+known-first-party = ["revenuebase_sdk"]

revenuebase_sdk-0.1.0/src/revenuebase_sdk/__init__.py

@@ -0,0 +1,74 @@
+"""
+Revenuebase Python SDK — email validation and company resolution.
+
+Usage::
+
+    from revenuebase_sdk import RevenuebaseClient
+
+    client = RevenuebaseClient(api_key="your-api-key")
+    result = client.email_processing.validate_email(email="user@acme.com")
+    print(result.status)  # "Valid", "Invalid", or "Unknown"
+"""
+from __future__ import annotations
+
+from ._version import __version__ as __version__
+from ._client import RevenuebaseClient as RevenuebaseClient
+from ._client import AsyncRevenuebaseClient as AsyncRevenuebaseClient
+from ._exceptions import (
+    RevenuebaseError as RevenuebaseError,
+    APIError as APIError,
+    APIConnectionError as APIConnectionError,
+    APITimeoutError as APITimeoutError,
+    APIStatusError as APIStatusError,
+    APIResponseValidationError as APIResponseValidationError,
+    BadRequestError as BadRequestError,
+    AuthenticationError as AuthenticationError,
+    PermissionDeniedError as PermissionDeniedError,
+    NotFoundError as NotFoundError,
+    ConflictError as ConflictError,
+    UnprocessableEntityError as UnprocessableEntityError,
+    RateLimitError as RateLimitError,
+    InternalServerError as InternalServerError,
+)
+from .types import (
+    CreditsResponse as CreditsResponse,
+    NewKeyResponse as NewKeyResponse,
+    EmailValidationResponse as EmailValidationResponse,
+    BatchEmailResponse as BatchEmailResponse,
+    BatchEmailStatusResponse as BatchEmailStatusResponse,
+    Process as Process,
+    QueuedProcessesResponse as QueuedProcessesResponse,
+    Company as Company,
+    CompanyResolverResponse as CompanyResolverResponse,
+)
+
+__all__ = [
+    "__version__",
+    "RevenuebaseClient",
+    "AsyncRevenuebaseClient",
+    # Exceptions
+    "RevenuebaseError",
+    "APIError",
+    "APIConnectionError",
+    "APITimeoutError",
+    "APIStatusError",
+    "APIResponseValidationError",
+    "BadRequestError",
+    "AuthenticationError",
+    "PermissionDeniedError",
+    "NotFoundError",
+    "ConflictError",
+    "UnprocessableEntityError",
+    "RateLimitError",
+    "InternalServerError",
+    # Types
+    "CreditsResponse",
+    "NewKeyResponse",
+    "EmailValidationResponse",
+    "BatchEmailResponse",
+    "BatchEmailStatusResponse",
+    "Process",
+    "QueuedProcessesResponse",
+    "Company",
+    "CompanyResolverResponse",
+]