The National Archives: Find Case Law

This repository is part of the Find Case Law project at The National Archives. For more information on the project, check the documentation.

MarkLogic API Client

PyPI Libraries.io dependency status for latest release Code Coverage

This is an API Client for connecting to Marklogic for The National Archive's Caselaw site.

This package is published on PyPI: https://pypi.org/project/ds-caselaw-marklogic-api-client/

Usage

You can find documentation of the client class and available methods here.

Testing

To run the test suite:

poetry install
poetry run pytest

There are also some smoketests in smoketests.py which run against a MarkLogic database but do not run in CI currently.

To run them locally you can set the environment variables as detailed in the file in a .env file or just hardcode them in, as long as you don't commit those changes to the repo.

And then run

poetry run pytest smoketest.py

To start with when running this, we have been choosing to point to the staging MarkLogic to have more confidence that the setup is a good representation of production as opposed to a local MarkLogic instance but that can work too.

Eventually we will make it so that we run these tests in CI and probably point to a dedicated testing MarkLogic instance so we don't get conflicts with people using staging for manual testing.

Making changes

When making a change, update the changelog using the Keep a Changelog 1.0.0 format. Pull requests should not be merged before any relevant updates are made.

Deployment

This repository will auto-deploy documentation to GitHub Pages when changes are made to main.

Release process

When making a new release, update the changelog in the release pull request.

The package will only be released to PyPI if the branch is tagged. A merge to main alone will not trigger a release to PyPI.

To create a release:

  1. Update the version number in pyproject.toml
  2. Create a branch release/v{major}.{minor}.{patch}
  3. Update CHANGELOG.md for the release
  4. Commit and push
  5. Open a PR from that branch to main
  6. Get approval on the PR
  7. Merge the PR to main and push
  8. Tag the merge commit on main with v{major}.{minor}.{patch} and push the tag
  9. Create a release in Github releases using the created tag

If the release fails to push to PyPI, you can delete the tag with git pull, git push --delete origin v1.2.3 and try again.

Project links

Data verified by PyPI on Jul 30, 2026
Data provided by the project maintainers, verified at the time the release was uploaded to PyPI.

Key dates

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

3 maintainers

PyPI data
Data sourced directly from PyPI's database.
Avatar for anthony_hashemi_TNA from gravatar.com anthony_hashemi_TNA Avatar for dxw from gravatar.com dxw Avatar for TNAWebmaster from gravatar.com TNAWebmaster

Credits

Author: The National Archives

GitHub Statistics

Data verified by PyPI on Jul 30, 2026
The GitHub source repository was provided by the project maintainers and verified by PyPI at the time of upload. Stars, forks, and open issues/PRs are derived from that repository and have not been independently verified.

Requires

Python <4.0.0, >=3.12.0

Tags

national archives caselaw

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

ds_caselaw_marklogic_api_client-48.0.0.tar.gz (79.0 kB view details)

Uploaded Source

Built Distribution

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

ds_caselaw_marklogic_api_client-48.0.0-py3-none-any.whl (121.6 kB view details)

Uploaded Python 3

File details

Details for the file ds_caselaw_marklogic_api_client-48.0.0.tar.gz.

File metadata

File hashes

Hashes for ds_caselaw_marklogic_api_client-48.0.0.tar.gz
Algorithm Hash digest
SHA256 3a2a2f0428b9c8f3e7f553c9b805c84e6cbf95788d8beadda1f8dea4b0457118
MD5 c430ee3c5329c9eab3a3126ff64e91b7
BLAKE2b-256 9e61e5a2576fe286512af277daa8c6c7dc44077f869c97b25fb23adfa4a64b42

See more details on using hashes here.

Provenance

The following attestation bundles were made for ds_caselaw_marklogic_api_client-48.0.0.tar.gz:

Publisher: publish.yml on nationalarchives/ds-caselaw-custom-api-client

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file ds_caselaw_marklogic_api_client-48.0.0-py3-none-any.whl.

File metadata

File hashes

Hashes for ds_caselaw_marklogic_api_client-48.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 cb5b979cb76dfa648375599ce64ef36843cc8c2be90d6068241a570aa7f16c76
MD5 eb0c4305ffd48468f2af3fe02450b8f2
BLAKE2b-256 df5497eef520a3835bd117e63938aa9d2478b3952d0045a77501983c0f028243

See more details on using hashes here.

Provenance

The following attestation bundles were made for ds_caselaw_marklogic_api_client-48.0.0-py3-none-any.whl:

Publisher: publish.yml on nationalarchives/ds-caselaw-custom-api-client

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

50.0.0

2 files

49.1.1

2 files

49.1.0

2 files

49.0.1

2 files

49.0.0

2 files

This release

48.0.0 This release

2 files

47.4.0

2 files

47.3.0

2 files

47.2.2

2 files

47.2.0

2 files

47.1.0

2 files

47.0.0

2 files

46.1.1

2 files

46.1.0

2 files

46.0.0

2 files

Yanked

45.1.0

2 files

45.0.1

2 files

45.0.0

2 files

44.5.0

2 files

44.4.5

2 files

44.4.4

2 files

44.4.3

2 files

44.4.2

2 files

44.4.1

2 files

44.4.0

2 files

44.3.0

2 files

44.2.1

2 files

44.2.0

2 files

44.1.1

2 files

44.1.0

2 files

44.0.3

2 files

44.0.2

2 files

44.0.1

2 files

44.0.0

2 files

43.1.0

2 files

43.0.0

2 files

42.0.0

2 files

41.1.3

2 files

41.1.2

2 files

41.1.1

2 files

41.1.0

2 files

41.0.0

2 files

40.0.0

2 files

39.2.1

2 files

39.2.0

2 files

39.1.0

2 files

39.0.0

2 files

38.0.0

2 files

37.4.0

2 files

37.3.1

2 files

37.3.0

2 files

37.2.0

2 files

37.1.0

2 files

37.0.2

2 files

37.0.1

2 files

37.0.0

2 files

36.0.2

2 files

36.0.1

2 files

36.0.0

2 files

35.1.1

2 files

35.1.0

2 files

35.0.0

2 files

34.1.2

2 files

34.1.1

2 files

34.1.0

2 files

34.0.2

2 files

34.0.1

2 files

34.0.0

2 files

33.0.0

2 files

32.0.0

2 files

31.2.0

2 files

31.1.0

2 files

31.0.1

2 files

31.0.0

2 files

30.0.0

2 files

29.2.0

2 files

29.1.1

2 files

29.1.0

2 files

29.0.1

2 files

29.0.0

2 files

Pre-release

29.0.0a2

2 files

28.2.0

2 files

28.1.0

2 files

28.0.0

2 files

27.4.0

2 files

27.3.0

2 files

27.2.0

2 files

27.1.0

2 files

27.0.1

2 files

27.0.0

2 files

26.0.0

2 files

25.0.0

2 files

24.0.1

2 files

24.0.0

2 files

23.0.2

2 files

23.0.1

2 files

22.1.0

2 files

22.0.2

2 files

22.0.1

2 files

22.0.0

2 files

21.0.0

2 files

20.0.0

2 files

19.1.0

2 files

19.0.0

2 files

18.0.0

2 files

17.3.0

2 files

17.2.0

2 files

17.1.0

2 files

17.0.0

2 files

16.0.0

2 files

15.1.2

2 files

15.1.1

2 files

15.1.0

2 files

15.0.1

2 files

15.0.0

2 files

14.1.0

2 files

14.0.2

2 files

14.0.1

2 files

14.0.0

2 files

13.2.1

2 files

13.1.0

2 files

13.0.0

2 files

12.0.0

2 files

11.0.1

2 files

11.0.0

2 files

10.1.0

2 files

10.0.1

2 files

10.0.0

2 files

9.0.0

2 files

8.0.0

2 files

7.0.0

2 files

6.1.0

2 files

6.0.0

2 files

5.3.2

2 files

5.3.1

2 files

Yanked

5.3.0

2 files

Yanked reason: breaking changes, includes all of src

5.2.6

2 files

5.2.5

2 files

5.2.4

2 files

5.2.3

2 files

5.2.2

2 files

5.2.1

2 files

5.2.0

2 files

5.1.4

2 files

5.1.3

2 files

5.1.2

2 files

5.1.1

2 files

5.1.0

2 files

5.0.0

2 files

4.10.0

2 files

4.9.2

2 files

4.9.1

2 files

4.9.0

2 files

4.8.0

2 files

4.7.1

2 files

4.7.0

2 files

4.6.0

2 files

4.5.4

2 files

4.5.3

2 files

4.5.2

2 files

4.5.1

2 files

4.4.0

2 files

4.3.0

2 files

4.2.0

2 files

4.1.0

2 files

4.0.0

2 files

3.2.0

2 files

3.0.2

2 files

3.0.1

2 files

3.0.0

2 files

2.1.2

2 files

2.1.1

2 files

2.1.0

2 files

2.0.1

2 files

2.0.0

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.0.7

2 files

0.0.5

2 files

0.0.4

2 files

0.0.3

2 files

0.0.2

2 files

0.0.1

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page