ds-caselaw-marklogic-api-client 23.0.2__tar.gz → 24.0.1__tar.gz

{ds_caselaw_marklogic_api_client-23.0.2 → ds_caselaw_marklogic_api_client-24.0.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ds-caselaw-marklogic-api-client
-Version: 23.0.2
+Version: 24.0.1
 Summary: An API client for interacting with the underlying data in Find Caselaw.
 Home-page: https://github.com/nationalarchives/ds-caselaw-custom-api-client
 Keywords: national archives,caselaw
@@ -11,7 +11,7 @@ Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Requires-Dist: boto3 (>=1.26.112,<2.0.0)
-Requires-Dist: certifi (>=2022.12.7,<2024.0.0)
+Requires-Dist: certifi (>=2024.7.4,<2024.8.0)
 Requires-Dist: charset-normalizer (>=3.0.0,<4.0.0)
 Requires-Dist: django-environ (>=0.11.0,<0.12.0)
 Requires-Dist: ds-caselaw-utils (>=1.4.1,<2.0.0)
@@ -20,6 +20,8 @@ Requires-Dist: lxml (>=5.0.0,<6.0.0)
 Requires-Dist: memoization (>=0.4.0,<0.5.0)
 Requires-Dist: mypy-boto3-s3 (>=1.26.104,<2.0.0)
 Requires-Dist: mypy-boto3-sns (>=1.26.69,<2.0.0)
+Requires-Dist: python-dateutil (>=2.9.0-post.0,<3.0.0)
+Requires-Dist: pytz (>=2024.1,<2025.0)
 Requires-Dist: requests (>=2.28.2,<3.0.0)
 Requires-Dist: requests-toolbelt (>=0.10.1,<1.1.0)
 Requires-Dist: typing-extensions (>=4.7.1,<5.0.0)
@@ -81,13 +83,15 @@ to main alone will **not** trigger a release to PyPI.
 To create a release:
 
 0. Update the version number in `pyproject.toml`
-0. Create a branch `release/v{major}.{minor}.{patch}`
-0. Update `CHANGELOG.md` for the release
-0. Commit and push
-0. Open a PR from that branch to main
-0. Get approval on the PR
-0. Merge the PR to main and push
-0. Tag the merge commit on `main` with `v{major}.{minor}.{patch}` and push the tag
-0. Create a release in [Github releases](https://github.com/nationalarchives/ds-caselaw-custom-api-client/releases)
-using the created tag
+1. Create a branch `release/v{major}.{minor}.{patch}`
+2. Update `CHANGELOG.md` for the release
+3. Commit and push
+4. Open a PR from that branch to main
+5. Get approval on the PR
+6. Merge the PR to main and push
+7. Tag the merge commit on `main` with `v{major}.{minor}.{patch}` and push the tag
+8. Create a release in [Github releases](https://github.com/nationalarchives/ds-caselaw-custom-api-client/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.
 

{ds_caselaw_marklogic_api_client-23.0.2 → ds_caselaw_marklogic_api_client-24.0.1}/README.md

@@ -54,12 +54,14 @@ to main alone will **not** trigger a release to PyPI.
 To create a release:
 
 0. Update the version number in `pyproject.toml`
-0. Create a branch `release/v{major}.{minor}.{patch}`
-0. Update `CHANGELOG.md` for the release
-0. Commit and push
-0. Open a PR from that branch to main
-0. Get approval on the PR
-0. Merge the PR to main and push
-0. Tag the merge commit on `main` with `v{major}.{minor}.{patch}` and push the tag
-0. Create a release in [Github releases](https://github.com/nationalarchives/ds-caselaw-custom-api-client/releases)
-using the created tag
+1. Create a branch `release/v{major}.{minor}.{patch}`
+2. Update `CHANGELOG.md` for the release
+3. Commit and push
+4. Open a PR from that branch to main
+5. Get approval on the PR
+6. Merge the PR to main and push
+7. Tag the merge commit on `main` with `v{major}.{minor}.{patch}` and push the tag
+8. Create a release in [Github releases](https://github.com/nationalarchives/ds-caselaw-custom-api-client/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.

ds_caselaw_marklogic_api_client-24.0.1/pyproject.toml

@@ -0,0 +1,77 @@
+[tool.poetry]
+name = "ds-caselaw-marklogic-api-client"
+version = "24.0.1"
+description = "An API client for interacting with the underlying data in Find Caselaw."
+authors = ["The National Archives"]
+homepage = "https://github.com/nationalarchives/ds-caselaw-custom-api-client"
+keywords = ["national archives", "caselaw"]
+readme = "README.md"
+packages = [
+    { include = "caselawclient", from = "src" },
+]
+
+[tool.poetry.dependencies]
+python = "^3.9"
+certifi = ">=2024.7.4,<2024.8.0"
+charset-normalizer = "^3.0.0"
+django-environ = "^0.11.0"
+idna = "^3.4"
+requests = "^2.28.2"
+requests-toolbelt = ">=0.10.1,<1.1.0"
+memoization = "^0.4.0"
+lxml = "^5.0.0"
+ds-caselaw-utils = "^1.4.1"
+boto3 = "^1.26.112"
+typing-extensions = "^4.7.1"
+mypy-boto3-s3 = "^1.26.104"
+mypy-boto3-sns = "^1.26.69"
+pytz = "^2024.1"
+python-dateutil = "^2.9.0-post.0"
+
+[tool.poetry.group.dev.dependencies]
+coverage = "^7.2.3"
+pytest = "^8.0.0"
+responses = "^0.25.0"
+python-dotenv = "^1.0.0"
+time-machine = "^2.13.0"
+moto = {version = "^5.0.1", extras = ["all"]}
+
+[tool.poetry.group.docs]
+optional = true
+
+[tool.poetry.group.docs.dependencies]
+pdoc = "^14.0.0"
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.pytest.ini_options]
+markers = [
+    "write: the test deliberately changes the Marklogic DB')",
+]
+filterwarnings = ["ignore::DeprecationWarning"]
+
+[tool.ruff]
+line-length = 120
+
+[tool.ruff.lint]
+ignore = ["E501", "G004", "PLR2004", "RUF005", "RUF012", "UP040"] # long lines, fstrings in logs, magic values, consider not concat, mutable classbits, type instead of TypeAlias
+extend-select = ["W", "B", "Q", "C90", "I", "UP", "YTT", "ASYNC", "S", "BLE", "A", "COM", "C4", "DTZ", "T10", "DJ", "EM", "EXE", "FA",
+                 "ISC", "ICN", "G", "INP", "PIE", "T20", "PYI", "PT", "Q", "RSE", "RET", "SLF", "SLOT", "SIM", "TID", "TCH", "INT", "PTH",
+                 "FIX", "PGH", "PL", "TRY", "FLY", "PERF", "RUF"]
+unfixable = ["ERA"]
+
+# things skipped:
+# N: naming, possibly good
+# D: docstrings missing throughout
+# ANN: annotations missing throughout
+# FBT: not convinced boolean trap worth auto-banning.
+# CPY: copyright at top of each file
+# G: logging warnings -- fstrings bad?
+# ARG: sometimes you need to accept arguments.
+# TD: somewhat finicky details about formatting TODOs
+# FIX: flags todos: possible to add -- skipped for now
+# ERA: lots of false positives, not a good autofix
+# PD, NPY, AIR: ignored, panda / numpy / airflow specific
+# FURB: not yet out of preview