JobStreaming

Concurrent, resumable job collection for Python.

JobStreaming collects and normalizes listings from multiple job boards, yielding each result as soon as its source returns it. Concurrent adapters, typed events, durable checkpoints, and stable job identities make it suitable for scripts, data pipelines, background workers, workflow engines, and job-market analysis.

It is a standalone Python package: no companion service or database is required. Some board adapters require operator-provided board credentials; the package does not ship shared credentials. Use the full event stream for durable ingestion, a job-only iterator for simple consumers, or the optional DataFrame API for batch analysis.

JobStreaming is an independently maintained, heavily modified fork of an MIT-licensed upstream project. It retains the original license and attribution while using a separate project, distribution, and import identity.

Alpha: job boards change private endpoints and markup without notice. Treat every adapter as a best-effort integration, respect each site's terms and rate limits, and persist the events you need. Adapter availability can drift between releases, and the project provides no uptime, compatibility, or support-response SLA.

What it provides

• Searches run concurrently across sites; a slow or blocked site does not hold back healthy sites.
• Jobs, warnings, progress, site failures, and completion are typed events.
• JSON checkpoints make searches restartable with at-least-once delivery; an optional SQLite store scales acknowledgement history without rewriting old keys.
• Stable job identities and checkpointed deduplication prevent acknowledged jobs from being emitted again after a restart.
• Adapter failures are isolated. The batch API returns healthy partial results unless strict failure mode is requested.
• Requests and result models are immutable and validated.
• A typed collect_jobs(...) -> SearchOutcome entry point preserves source identity, per-site terminal summaries, and chronological failures without building a DataFrame.
• An optional scrape_jobs(...) -> pandas.DataFrame entry point for batch and analysis workflows.
• Adapters are registered through an extensible registry rather than a hard-coded dispatcher.

Choose the interface that matches your consumer:

flowchart LR
    A["SearchRequest"] --> B["Concurrent coordinator"]
    B --> C1["Indeed worker"]
    B --> C2["LinkedIn worker"]
    B --> C3["Other site workers"]
    C1 --> D["Bounded event queue"]
    C2 --> D
    C3 --> D
    D --> E["Job / progress / error events"]
    E --> F["Consumer"]
    F -->|"acknowledge"| G["Atomic checkpoint"]
    G -->|"resume"| B

Installation

Python 3.10 through Python 3.14 are tested.

Install the published package from PyPI:

pip install -U jobstreaming

The default installation contains the streaming runtime and does not install or import Pandas. Install the optional batch surface when you need DataFrames:

pip install -U "jobstreaming[batch]"

Both the PyPI distribution and Python import package are jobstreaming. No legacy import alias or host application is required.

Board credentials and TLS configuration

JobStreaming does not embed reusable board credentials or fallback tokens. Configure only the adapters you are authorized to use, preferably through a process-level secret manager:

ZipRecruiter also accepts optional JOBSTREAMING_ZIPRECRUITER_DEVICE_ID, JOBSTREAMING_ZIPRECRUITER_PUSH_NOTIFICATION_ID, and JOBSTREAMING_ZIPRECRUITER_ZVA_OVERRIDE values when your authorized integration requires them. Never commit these values or include them in fixtures, logs, issues, or checkpoint files.

ca_cert is supported by adapters built on requests. Glassdoor and ZipRecruiter use tls-client, whose current Python API cannot consume a custom CA bundle; those adapters raise AuthenticationConfigurationError when ca_cert is supplied instead of silently ignoring it. Use system trust, a correctly configured proxy, or a custom requests-based adapter when a private CA is required.

Stream results immediately

from jobstreaming import ErrorEvent, JobEvent, SearchCompleteEvent, stream_search

with stream_search(
    site_name=["indeed", "linkedin", "zip_recruiter"],
    search_term="software engineer",
    location="Madrid",
    results_wanted=20,  # per site
    checkpoint_path=".jobstreaming/search.json",
    resume=True,
    ack_mode="explicit",
) as stream:
    for event in stream:
        if isinstance(event, JobEvent):
            print(event.site.value, event.job.title, event.job.job_url)

            # Persist the job first when durability matters, then explicitly ack it.
            save_to_database(event.job)

        elif isinstance(event, ErrorEvent):
            print(f"{event.site.value} failed: {event.message}")

        elif isinstance(event, SearchCompleteEvent):
            print("all sites completed:", event.completed)

        stream.ack(event)

Each site runs in its own worker. Arrival order is intentionally unspecified: faster sites and faster pages yield first.

For a job-only iterator:

from jobstreaming import stream_jobs

for job in stream_jobs(
    site_name=["indeed", "google"],
    search_term="data engineer",
    location="Barcelona",
    results_wanted=10,
):
    print(job.title)

Use stream_search when you need errors, progress, source-site metadata, or explicit checkpoint acknowledgements.

Restart and delivery semantics

Checkpointing is opt-in. Pass either checkpoint_path or a custom CheckpointStore. checkpoint_path intentionally remains the simple JSON default.

• The default ack_mode="implicit" preserves the convenient behavior where requesting the next event acknowledges the previous event.
• Use ack_mode="explicit" for durable consumers. In this mode, requesting another event before stream.ack(event) raises UnacknowledgedEventError and does not advance the checkpoint.
• Call stream.ack(event) after a durable write when you need the checkpoint advanced immediately.
• Leaving the context manager early does not acknowledge the last delivered event; call stream.ack(event) first when an intentional early stop should be committed.
• If execution stops before acknowledgement, that job can be replayed on restart. This is at-least-once delivery: it favors avoiding data loss over pretending exactly-once delivery is possible.
• Acknowledged jobs are deduplicated with stable, process-independent keys.
• Page and cursor state advances only after the corresponding progress event is acknowledged. Provider cursors remain private to the stream/checkpoint runtime; consumers receive normalized ProviderProgress facts instead.
• Only failures classified as transient_network or rate_limited are retried by default. Configure max_retries and retry_backoff on stream_search or scrape_jobs. max_retries means coordinator retries after the initial adapter attempt; adapters do not hide additional transport retries.
• Valid Retry-After delta or HTTP-date values on retryable board responses are honored, capped at five minutes. The selected delay is the larger of Retry-After and exponential retry_backoff.
• The checkpoint is written through an fsync plus atomic file replacement.
• Checkpoints carry an overall schema version, an opaque generation identity, a monotonically increasing revision within that generation, and a cursor-state schema version for every adapter. An incompatible library or adapter upgrade raises CheckpointCompatibilityError before any board worker starts.
• A checkpoint is bound to the complete request fingerprint. Changing the query, filters, sites, or result count raises CheckpointMismatchError; use a new path or resume=False for a new search.
• Board-owned cursors can expire. If a board rejects an old cursor, the stream emits an ErrorEvent with code="cursor_expired" and reset_checkpoint=True; restart that site from a fresh checkpoint.
• Custom stores can provide compare-and-swap ownership using both checkpoint.generation and checkpoint.revision. Raise CheckpointConflictError for a stale save; the conflict is surfaced to the caller immediately and the stream stops without advancing its local checkpoint.

For long-running or high-volume searches, use the stdlib-only SQLite store:

from jobstreaming import SqliteCheckpointStore, stream_search

store = SqliteCheckpointStore(".jobstreaming/search.sqlite3")

with stream_search(
    site_name=["indeed", "linkedin"],
    search_term="platform engineer",
    checkpoint_store=store,
    ack_mode="explicit",
) as stream:
    for event in stream:
        persist(event)
        stream.ack(event)

One SQLite file owns one search checkpoint aggregate. Its header, adapter state, and ordered seen-key history advance in one BEGIN IMMEDIATE transaction. Revision compare-and-swap rejects concurrent stale owners, and each job acknowledgement appends one key instead of serializing or rewriting all historical keys. load() reconstructs the complete public SearchCheckpoint only when starting/resuming a stream or when checkpoint introspection is requested. Call store.clear() or use resume=False to replace the file with a new search. A cleared and reseeded checkpoint receives a new generation, so an owner from before the clear cannot pass compare-and-swap even when the new search has the same request fingerprint and restarts at revision zero. Serialized checkpoints and supported SQLite schema-version-1 databases created before this field existed load under a stable legacy generation; SQLite adds the missing column only after its future-schema compatibility preflight succeeds.

Built-in stores implement AtomicCheckpointStore, so resume=False replaces an existing search checkpoint in one all-or-nothing transition. Custom stores that only implement CheckpointStore remain compatible and retain the existing clear() then save() reset sequence; implement AtomicCheckpointStore.replace() when a custom backend must preserve its previous checkpoint if reseeding fails. The method returns the checkpoint that was actually persisted, allowing a store to advance its revision as part of the replacement. SQLite does so when a prior checkpoint exists, fencing stale owners even when the replacement uses the same request fingerprint.

Custom high-volume stores can independently implement IncrementalCheckpointStore and accept the immutable CheckpointWrite command. Ordinary CheckpointStore implementations continue receiving complete snapshots through save().

If a process crashes while handling a job, replay is expected. Make downstream writes idempotent using event.job_key or the job's stable id.

Typed and DataFrame batch APIs

Use collect_jobs when application code needs a complete typed outcome:

from jobstreaming import SearchOutcomeStatus, collect_jobs

outcome = collect_jobs(
    site_name=["indeed", "linkedin", "google"],
    search_term="software engineer",
    location="Madrid",
    results_wanted=20,
)

for sourced in outcome.jobs:
    print(sourced.site.value, sourced.job.title)

for site in outcome.sites:
    print(site.site.value, site.jobs_emitted, site.failure_count, site.completed)

if outcome.status is SearchOutcomeStatus.PARTIAL:
    handle_partial_result(outcome)

SUCCEEDED means every requested site reached terminal completion. PARTIAL means a failure occurred after at least one job was emitted or another site completed; FAILED means no site completed and no job was retained. Aggregate failures are ordered by stream sequence, not request-site order. Set raise_on_error=True to raise SearchFailedError only after collection finishes; the exception remains compatible with RuntimeError and carries the full outcome, including partial jobs and every failure.

Outcome totals and jobs_emitted counters describe only the current invocation. On a resumed search, an already-completed site is reported as completed with zero newly emitted jobs. Cancellation is not a failed outcome: collect_jobs propagates StreamCancelledError, while its managed stream still performs the same transport shutdown and bounded cleanup described below.

collect_jobs does not construct a DataFrame and remains available in the default installation without Pandas.

Use scrape_jobs when the desired result is a Pandas DataFrame:

Install jobstreaming[batch] before using this compatibility API:

from jobstreaming import scrape_jobs

jobs = scrape_jobs(
    site_name=["indeed", "linkedin", "zip_recruiter", "google"],
    search_term="software engineer",
    google_search_term="software engineer jobs near Madrid since yesterday",
    location="Madrid",
    results_wanted=20,
    hours_old=72,
    country_indeed="Spain",
)

jobs.to_csv("jobs.csv", index=False)

scrape_jobs delegates collection to the typed outcome path, logs site failures, and converts retained jobs to a DataFrame. By default, healthy partial results are returned. Its raise_on_error=True mode raises the same SearchFailedError after all sites have had a chance to finish. Calling it from a core-only installation raises MissingOptionalDependencyError before any adapter or network work begins, with the exact extra needed to enable it.

Checkpoints store identities and cursor state, not full job payloads. A resumed batch call therefore contains only jobs emitted during that invocation. For a durable full result set across restarts, use stream_search and upsert each JobEvent into your own store before acknowledging it.

Salary provenance and description inference

Structured compensation returned by a board is authoritative and is never replaced by description text. Normalized jobs attach salary_provenance with the source, confidence, and—only for description-derived values—the matched evidence snippet:

• direct_data is high confidence.
• Board-provided estimated compensation is medium confidence.
• Description-derived compensation is medium confidence and must be enabled explicitly.

Description inference is off by default. This replaces the earlier implicit US-only heuristic, which guessed an interval from numeric thresholds. Opt in per request:

from jobstreaming import DescriptionSalaryPolicy, stream_jobs

jobs = stream_jobs(
    site_name="google",
    search_term="platform engineer",
    country_indeed="Spain",
    description_salary_policy=DescriptionSalaryPolicy.CONSERVATIVE,
)

The conservative parser requires a nearby compensation cue, a range, an explicit pay interval, and an explicit or country-resolved currency. It handles common English, Spanish, Catalan, French, German, Portuguese, and Italian compensation and interval terms plus localized thousands/decimal separators. Ambiguous dollar symbols are resolved only for USD, CAD, AUD, or NZD request countries; bonuses, commissions, equity, budgets, costs, revenue, contract values, missing intervals, and reversed ranges are rejected. enforce_annual_salary=True annualizes accepted compensation without changing its provenance.

The batch schema exposes flattened salary_source, salary_confidence, and salary_evidence columns alongside interval, min_amount, max_amount, and currency.

Events

stream_search can yield:

ProgressEvent.site identifies the source. Its immutable progress payload is a client-safe ProviderProgress value with these fields:

Opaque cursors, continuation tokens, and adapter resume dictionaries are deliberately absent from ProgressEvent. Acknowledging the event still commits its private resume state, so it remains the same durable restart boundary. Do not derive a percentage unless total_units is present, and keep application/business counters separate from these provider traversal facts.

ErrorEvent.code is a stable ErrorCode value. retryable tells an operator whether the same board operation can be retried, while reset_checkpoint tells them whether the board cursor should be discarded first. retry_after preserves a valid, bounded board-requested delay on a retryable terminal failure.

Cancellation

Supply a threading.Event, a callback, or both. Queue waits, retry backoff, and blocked adapter/network operations are observed through the same cancellation boundary. close() also wakes a consumer blocked in next(). Cancellation is monotonic: after an event is set or a callback returns True once, that stream remains cancelled and cannot later report a healthy completion.

close() intentionally returns promptly: it signals every worker, closes registered adapter transports, and schedules cleanup without waiting for an uncooperative third-party call. When an application must prove that no managed resource remains active, follow it with a bounded wait and inspect the immutable diagnostics:

stream.close()
diagnostics = stream.wait_closed(timeout=2)
if not diagnostics.quiescent:
    print("still stopping:", diagnostics.active_operations)
if diagnostics.cleanup_errors:
    print("transport cleanup failed:", diagnostics.cleanup_errors)

wait_closed() never cancels work itself and always requires a finite, non-negative timeout. stream.diagnostics provides the same snapshot without waiting. Worker, blocking-operation, and adapter-cleanup threads are daemon threads; their names and counts are exposed for shutdown monitoring rather than hidden. Closing is idempotent: once close(acknowledge=False) has stopped a stream, a later close call cannot retroactively acknowledge its last event.

from threading import Event

from jobstreaming import StreamCancelledError, stream_search

cancel = Event()

try:
    with stream_search(
        site_name=["indeed", "linkedin"],
        search_term="platform engineer",
        cancel_event=cancel,
        # cancel_callback=lambda: shutdown_requested(),  # optional alternative
    ) as stream:
        for event in stream:
            process(event)
except StreamCancelledError:
    pass

Supported sites and important limits

Adapters declare their supported filter names and, for enum filters such as job_type, supported values. If a selected adapter cannot honor a requested filter or value, the stream emits a WarningEvent and omits the parameter instead of silently implying that it was applied.

Validated request API

For reusable searches, construct an immutable request explicitly:

from jobstreaming import Country, SearchRequest, Site, stream_search

request = SearchRequest(
    site_type=(Site.INDEED, Site.LINKEDIN),
    search_term="platform engineer",
    location="Madrid",
    country=Country.SPAIN,
    results_wanted=25,
    request_timeout=20,
    max_pages=10,
)

with stream_search(request, checkpoint_path="search.json") as stream:
    for event in stream:
        ...

Negative offsets/result counts, invalid timeouts, malformed compensation ranges, empty job titles/URLs, and unsupported enum values are rejected at the boundary.

Custom adapters

The adapter SDK uses five domain terms:

• Adapter identifier: a stable AdapterId for a custom source; built-in sources continue to use Site.
• Search filter: a SearchFilter the source genuinely applies.
• Resume support: either NoResume or Resumable with an open, validated ResumeGranularity value and cursor schema version.
• Adapter: the structural Adapter protocol; inheritance is optional.
• Adapter test kit: offline helpers that validate construction, identity, and fixture-driven resume behavior without requiring pytest at runtime.

from jobstreaming import (
    AdapterCapabilities,
    AdapterId,
    AdapterRegistry,
    AdapterTestKit,
    JobResponse,
    Resumable,
    ResumeGranularity,
    Scraper,
    SearchFilter,
    stream_search,
)

class InternalJobs(Scraper):
    identifier = AdapterId("company.internal_jobs")
    capabilities = AdapterCapabilities(
        filters=frozenset({SearchFilter.SEARCH_TERM}),
        resume=Resumable(
            granularity=ResumeGranularity.CURSOR,
            cursor_schema_version=1,
        ),
    )

    def __init__(self, proxies=None, ca_cert=None, user_agent=None, **kwargs):
        super().__init__(self.identifier)
        self.session = self.track_transport(make_internal_session())

    def scrape(self, request, context=None):
        state = context.resume_state
        cursor = state.get("cursor")
        pages_completed = int(state.get("pages_completed", 0))
        raw_items_seen = int(state.get("raw_items_seen", 0))

        jobs, next_cursor = fetch_internal_page(request, cursor)
        for job in jobs:
            context.emit_job(job, state)
        raw_items_seen += len(jobs)
        context.emit_progress(
            {
                "cursor": next_cursor,
                "pages_completed": pages_completed + 1,
                "raw_items_seen": raw_items_seen,
            },
            completed_units=pages_completed + 1,
            raw_items_seen=raw_items_seen,
            has_more=next_cursor is not None,
        )
        return JobResponse()

registry = AdapterRegistry()
registry.register(InternalJobs.identifier, InternalJobs)
AdapterTestKit.assert_conforms(InternalJobs.identifier, InternalJobs)

with stream_search(
    site_name=InternalJobs.identifier,
    registry=registry,
    search_term="engineer",
) as stream:
    for event in stream:
        ...

Increment cursor_schema_version whenever a deployed adapter can no longer interpret cursor state written by its previous implementation. Custom identifiers are validated, serialized as strings in requests/events/checkpoints, and must not collide with a built-in Site. Resume granularities are also open to third-party values; spaces and hyphens normalize to underscores, so the legacy "continuation token" value becomes ResumeGranularity("continuation_token").

The first argument to emit_progress() is private checkpoint state. The keyword arguments are the normalized public contract. Supply None for an unavailable raw count or continuation fact, and leave total_units unset unless the provider returns an authoritative total.

Register every closeable client/session with track_transport(), including sessions created lazily or inside detail-worker threads. The base Scraper.close() closes each registered transport once; adapters with additional resources can override close() and call super().close(). Use transport_scope() around a bounded page/detail batch so its thread-local sessions are released before the next page. Scopes are reentrant and serialize overlapping batches on the same adapter, preventing one batch from closing transports owned by another. A transport registered after adapter shutdown is closed and rejected with RuntimeError; it is never returned to adapter code as a usable client. Transport close failures remain visible in stream.diagnostics.cleanup_errors, including failures from late registration races.

Site arguments and built-in site strings remain compatible. The legacy supports_resume / resume_granularity constructor fields still parse with a DeprecationWarning; migrate to resume=Resumable(...) or resume=NoResume(). Adapters must expose AdapterCapabilities, and factories that declare capabilities must produce the same value. An ordinary function factory may omit a class-level declaration; registration then uses a provisional cursor schema version of 1 (or an explicit deprecated registration value) and validates the first produced instance before scraping. A discovered resume-schema mismatch fails instead of writing an incompatible checkpoint.

Adapters should implement scrape(request, context=None). Runtime execution no longer inspects method signatures. Registration temporarily detects the old scrape(request) form and warns; use legacy_adapter(factory) as an explicit non-resumable bridge while migrating. That bridge preserves declared filters and job-type support while disabling resume, and forwards lifecycle cleanup to a wrapped adapter's close() hook. Implicit legacy detection is scheduled for removal in 1.0.

The distribution includes py.typed, so consumers can type-check protocol implementations and capability declarations.

Development

poetry install --all-extras
poetry run pytest --cov
poetry run python scripts/check_coverage.py
poetry run ruff check jobstreaming tests scripts
poetry run pyrefly check
poetry run black --check jobstreaming tests scripts
poetry build
python scripts/verify_release_artifacts.py \
  --expected-version "$(poetry version --short)" \
  --dist-dir dist

The deterministic checkpoint benchmark uses fixed 10,000 and 100,000 acknowledgement workloads, verifies final revisions and key counts, and reports elapsed time and database size without a timing assertion:

poetry run python -m tools.benchmark_checkpoints

The test suite is offline: it validates domain invariants, concurrency, failure isolation, acknowledgement/replay behavior, checkpoint persistence, compatibility, and representative adapter parsing without calling live job boards.

The separate Adapter live canary workflow is opt-in and never runs as part of pull request CI. Set the repository variable JOBSTREAMING_CANARY_ENABLED=true, configure JOBSTREAMING_CANARY_SITES as a comma-separated list of boards you are authorized to query, and add only the corresponding JOBSTREAMING_* repository secrets. Optional JOBSTREAMING_CANARY_QUERY and JOBSTREAMING_CANARY_LOCATION variables keep the minimal one-result queries stable. An unconfigured workflow exits successfully without contacting any board, and its output contains only board names and aggregate status.

Support and security

Use GitHub issues for reproducible bugs, adapter drift reports, and non-sensitive support questions. Include the JobStreaming version, selected adapter, sanitized error event, and an offline reproduction when possible.

Do not place credentials or vulnerability details in an issue. See SECURITY.md for private reporting and supported-version policy, and CONTRIBUTING.md before submitting a change. Release history is in CHANGELOG.md, and the maintainer release contract is in RELEASING.md.

License and attribution

MIT. The retained license identifies Cullen Watson as the original copyright holder. This rebuild is independently maintained and is not affiliated with the original creator or any supported job board.