Skip to content

marklogic/marklogic-python-client

Repository files navigation

MarkLogic Python Client

The Python requests library allows Python developers to easily create applications that communicate with the MarkLogic REST API. The MarkLogic Python Client further simplifies usage of the requests library by supporting common authentication strategies with MarkLogic and improving the user experience with some of the more common endpoints in the MarkLogic REST API.

The client requires Python 3.9 or higher. It is available at PyPI and can be installed via pip:

pip install marklogic-python-client

The client's sole dependency with MarkLogic is on the MarkLogic REST API. MarkLogic 10 and higher is supported, and earlier versions of MarkLogic that support the MarkLogic REST API are likely to work as well though are not tested.

An instance of the client can be easily created and then used in the exact same way as the requests API:

from marklogic import Client
client = Client("http://localhost:8000", digest=("python-user", "pyth0n"))
response = client.get("/v1/search", params={"q": "marklogic and python", "pageLength": 100})

Please see the user guide to start using the client.