An API client for interacting with the underlying data in Find Caselaw.
Project description
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
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
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.
Releasing
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:
- Update the version number in
pyproject.toml
- Create a branch
release/v{major}.{minor}.{patch}
- Update
CHANGELOG.md
for the release - Commit and push
- Open a PR from that branch to main
- Get approval on the PR
- Merge the PR to main and push
- Tag the merge commit on
main
withv{major}.{minor}.{patch}
and push the tag - Create a release in Github releases using the created tag
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for ds_caselaw_marklogic_api_client-13.1.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | acf051e38ffe646a64952aba0a4b02a1dc5ab90bbe2e5f2945d3280491153c13 |
|
MD5 | bb16b6bea11863ab1faad25c5a25cf65 |
|
BLAKE2b-256 | 603c25e0ed2f83cd7cf0761191f453f02d2f0a602b9ff6dc6afe2ae4fa792873 |
Hashes for ds_caselaw_marklogic_api_client-13.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | afded8d20b0320dee5b037f72406f857e3f12724bbeb7ef521d76d0f1d001f3a |
|
MD5 | 9af6e1d1c8a1d75f83c57d9efcee8664 |
|
BLAKE2b-256 | 176dcfd7fe7d17d51634358389cf331bac5bc2cb8c45349fc6bb695fe28821eb |