Merge Python Library

fern shield pypi

The Merge Python library provides convenient access to the Merge APIs from Python.

Table of Contents

Documentation

API reference documentation is available here.

Installation

pip install MergePythonClient

Reference

A full reference for this library is available here.

Usage

Instantiate and use the client with the following:

from merge import Merge

client = Merge(
    api_key="<token>",
)

client.ats.account_token.regenerate_create()

Instantiation

import merge
from merge.client import Merge

client = Merge(api_key="YOUR_API_KEY", account_token="YOUR_ACCOUNT_TOKEN")

Categories

This SDK contains the ATS, HRIS, CRM, Ticketing, Accounting, and File Storage categories. Even if you do not plan on using more than one Merge API category right now, the SDK provides upgrade-flexibility in case you find new Merge API categories useful in the future.

Each category is namespaced:

client = Merge(api_key="YOUR_API_KEY")

client.ats. # APIs specific to the ATS Category

client.hris. # APIs specific to the HRIS Category

Async Client

The SDK also exports an async client so that you can make non-blocking calls to our API. Note that if you are constructing an Async httpx client class to pass into this client, use httpx.AsyncClient() instead of httpx.Client() (e.g. for the httpx_client parameter of this client).

import asyncio

from merge import AsyncMerge

client = AsyncMerge(
    api_key="<token>",
)


async def main() -> None:
    await client.ats.account_token.regenerate_create()


asyncio.run(main())

Exception Handling

When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error will be thrown.

from merge.core.api_error import ApiError

try:
    client.ats.account_token.regenerate_create()
except ApiError as e:
    print(e.status_code)
    print(e.body)

Advanced

Access Raw Response Data

The SDK provides access to raw response data, including headers, through the .with_raw_response property. The .with_raw_response property returns a "raw" client that can be used to access the .headers and .data attributes.

from merge import Merge

client = Merge(...)
response = client.ats.account_token.with_raw_response.regenerate_create()
print(response.headers)  # access the response headers
print(response.status_code)  # access the response status code
print(response.data)  # access the underlying object

Retries

The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long as the request is deemed retryable and the number of retry attempts has not grown larger than the configured retry limit (default: 2).

A request is deemed retryable when any of the following HTTP status codes is returned:

  • 408 (Timeout)
  • 429 (Too Many Requests)
  • 5XX (Internal Server Errors)

Use the max_retries request option to configure this behavior.

client.ats.account_token.regenerate_create(request_options={
    "max_retries": 1
})

Timeouts

The SDK defaults to a 60 second timeout. You can configure this with a timeout option at the client or request level.

from merge import Merge

client = Merge(..., timeout=20.0)

# Override timeout for a specific method
client.ats.account_token.regenerate_create(request_options={
    "timeout_in_seconds": 1
})

Custom Client

You can override the httpx client to customize it for your use-case. Some common use-cases include support for proxies and transports.

import httpx
from merge import Merge

client = Merge(
    ...,
    httpx_client=httpx.Client(
        proxy="http://my.test.proxy.example.com",
        transport=httpx.HTTPTransport(local_address="0.0.0.0"),
    ),
)

Contributing

While we value open-source contributions to this SDK, this library is generated programmatically. Additions made directly to this library would have to be moved over to our generation code, otherwise they would be overwritten upon the next generated release. Feel free to open a PR as a proof of concept, but know that we will not be able to merge it as-is. We suggest opening an issue first to discuss with us!

On the other hand, contributions to the README are always very welcome!

File Download

import merge
from merge.client import Merge

merge_client = Merge(
    api_key="<YOUR_API_KEY>", 
    account_token="<YOUR_ACCOUNT_TOKEN>")

files = merge_client.filestorage.files.list(name="<FILE_NAME>").results

id = files[0].id
name = files[0].name
local_filename = f"<LOCAL_FILE_PATH>/{name}"

response = merge_client.filestorage.files.download_retrieve(id=id)
with open(local_filename, "wb") as f:
    for chunk in response:
        f.write(chunk)

Pagination

The SDK may return paginated results. Endpoints that return paginated results will include a next and prev property on the response. To get the next page, you can pass in the value of next to the cursor property on the request. Similarly, to get the previous page, you can pass in the value of prev to the cursor property on the request.

Below is an example of iterating over all pages:

# response contains the first page
response = merge_client.hris.employees.list(created_after="2030-01-01")

# if there is a next page, load it by passing `next` to the cursor argument
while response.next is not None:
    response = hris_client.employees.list(
        cursor=response.next, 
        created_after="2030-01-01")

Project links

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Newer release available (4.1.0)

2 maintainers

PyPI data
Data sourced directly from PyPI's database.
Avatar for dan-merge from gravatar.com dan-merge Avatar for merge-experience from gravatar.com merge-experience

Requires

Python <4.0, >=3.10

Classifiers

Report project as malware

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mergepythonclient-4.0.0.tar.gz (1.2 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mergepythonclient-4.0.0-py3-none-any.whl (3.0 MB view details)

Uploaded Python 3

File details

Details for the file mergepythonclient-4.0.0.tar.gz.

File metadata

  • Download URL: mergepythonclient-4.0.0.tar.gz
  • Upload date:
  • Size: 1.2 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.5.1 CPython/3.10.20 Linux/6.17.0-1020-azure

File hashes

Hashes for mergepythonclient-4.0.0.tar.gz
Algorithm Hash digest
SHA256 3c03d1051d44e13e6d57a7f86f5fcadf2e75d5cfb3321a09567709b1b97557fc
MD5 a82ee59c302d5d4b57a41abb2ca5b8d7
BLAKE2b-256 7a6582a66e7c3f4039d37eaff4fb04fc2fb883ab6be38729c3144374afe55ebd

See more details on using hashes here.

File details

Details for the file mergepythonclient-4.0.0-py3-none-any.whl.

File metadata

  • Download URL: mergepythonclient-4.0.0-py3-none-any.whl
  • Upload date:
  • Size: 3.0 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.5.1 CPython/3.10.20 Linux/6.17.0-1020-azure

File hashes

Hashes for mergepythonclient-4.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 69ed906c4b461e0dfddf8caf8fa899a55e5265cfd10bd43ce270286e5c642f3d
MD5 1d9ec8399631e8297d80cce0c33b8e59
BLAKE2b-256 e41d7c76779deb73b0f378aaf20c5c56c6b672d6480754e5201e47b66faed0f4

See more details on using hashes here.

Release history Release notifications | RSS feed

4.1.0

2 files

This release

4.0.0 This release

2 files

3.1.0

2 files

Pre-release

3.1.0a1

2 files

3.0.1

2 files

3.0.0

2 files

Pre-release

3.0.0a1

2 files

2.6.4

2 files

2.6.3

2 files

2.6.2

2 files

2.6.1

2 files

2.6.0

2 files

2.5.0

2 files

2.4.0

2 files

2.3.2

2 files

2.3.1

2 files

2.3.0

2 files

2.2.0

2 files

2.1.1

2 files

2.1.0

2 files

2.0.0

2 files

1.2.1

2 files

1.2.0

2 files

1.1.4

2 files

1.1.3

2 files

1.1.2

2 files

1.1.1

2 files

1.1.0

2 files

1.0.13

2 files

1.0.12

2 files

1.0.11

2 files

1.0.10

2 files

1.0.9

2 files

1.0.8

2 files

1.0.7

2 files

1.0.6

2 files

1.0.5

2 files

1.0.4

2 files

1.0.3

2 files

1.0.2

2 files

1.0.1

2 files

1.0.0

2 files

0.2.11

2 files

0.2.10

2 files

0.2.9

2 files

0.2.8

2 files

0.2.7

2 files

0.2.6

2 files

0.2.5

2 files

0.2.4

2 files

0.2.3

2 files

0.2.2

2 files

0.2.1

2 files

0.2.0

2 files

0.1.2

2 files

0.1.1

2 files

0.1.0

2 files

0.0.1

2 files

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page