Merge pull request #14 from LexMachinaInc/feature/v2

Feature: [#13] Python client v2

Author: fwong03

.vscode/settings.json

@@ -12,3 +12,11 @@ Synchronized LexMachinaClient to match current live API.
 - Added `list_originating_venues_federal`
 - Added `list_appellate_decisions_federal`
 - Added `list_supreme_court_decisions_federal`
+
+
+2025-04-22 v2.0.0.20250318
+
+Used the Python generator from [openapi-generator](https://openapi-generator.tech/docs/generators/python/) to generate a Python client based on the current version of the Lex Machina API (v20250318).
+
+- The updated client has methods for recently added endpoints such as those accessing alerts results and searching for cases by case number.
+- The previous version of the client is accessible under a `v1` subpackage. We will not be providing continuing support for the `v1` subpackage and it will be removed in 2026.

CHANGELOG.md

@@ -0,0 +1,9 @@
+# Generating a Python client
+
+These steps are provided as an example of how to generate a client in the event you would like to generate your own.
+
+We used the python generator from [openapi-generator](https://openapi-generator.tech/docs/generators/python/). They provide generators for various languages.
+
+1. Install [openapi-generator](https://openapi-generator.tech/docs/installation)
+2. To get help with options for the python generator: ``openapi-generator-cli config-help -g python``
+3. To generate a python client specifying a directory of custom templates: ``openapi-generator-cli generate -g python -c config/open_api_autogenerator_config.yml -i config/openapi.json -o src -t custom_templates``

README.md

@@ -1,3 +1,4 @@
+# TODO Used for v1 only - can delete after get rid of v1
 [URLS]
 token_url = /oauth2/token
 base_url = https://api.lexmachina.com

config/autogeneration.md

@@ -0,0 +1,7 @@
+basePath: "https://api.lexmachina.com"
+disallowAdditionalPropertiesIfNotPresent: False
+generateSourceCodeOnly: True
+packageName: lexmachina
+packageVersion: "2.0.0.20250318"
+packageUrl: "https://pypi.org/project/lexmachina-client/"
+projectName: python-lexmachina-api-client