1import os
 2
 3if os.getenv("PDOC_DYNAMIC_VERSION") == "1":
 4    from pathlib import Path
 5
 6    import tomllib
 7
 8    pyproject_path = Path(__file__).parent.parent.parent / "pyproject.toml"
 9    with pyproject_path.open("rb") as f:
10        __version__ = tomllib.load(f)["tool"]["poetry"]["version"]
11        __pip_version_string__ = f"~={__version__}"
12        __poetry_version_string__ = f' = "^{__version__}"'
13
14else:
15    __pip_version_string__ = ""
16    __poetry_version_string__ = ""
17
18__doc__ = f"""
19
20# Installation
21
22Include the API client in your project using Pip or Poetry:
23
24```bash
25pip install ds-caselaw-marklogic-api-client
26```
27
28```bash
29poetry add ds-caselaw-marklogic-api-client
30```
31
32or in your projects `requirements.txt` with:
33
34```text
35ds-caselaw-marklogic-api-client{__pip_version_string__}
36```
37
38or `pyproject.toml` for Poetry with:
39
40```text
41ds-caselaw-marklogic-api-client{__poetry_version_string__}
42```
43
44# Usage
45
46## Initialising the client
47
48Import the `MarklogicApiClient` class and instantiate with appropriate credentials:
49
50```python
51
52from caselawclient.Client import MarklogicApiClient
53
54client = MarklogicApiClient(
55    host="hostname",
56    username="username",
57    password="password",
58    use_https=True,
59)
60
61```
62
63"""