python-lexmachina-api-client

Lex Machina诉讼分析API的Python客户端

此软件包提供了一个访问Lex Machina API进行法律分析的客户端。访问和文档可在Lex Machina API开发者门户找到。

入门指南

1. 使用以下命令创建一个新的venv: python3 -m venv /path/to/new/virtual/environment

2. 运行 python3 -m pip install --upgrade pip setuptools wheel

3. 使用 pip3 install lexmachina-client 安装软件包。

4. 在此处创建一个应用并获取客户端密钥和密钥。

5. 在项目目录中创建一个名为 config 的目录，并在其中创建一个名为 config.ini 的文件。使用以下值和上面的密钥和密钥填充。如果使用Lex Machina的生产API，应使用以下URLS的值。

   [URLS]
   token_url = /oauth2/token
   base_url = https://api.lexmachina.com
   
   [CREDENTIALS]
   client_id = "CLIENT_ID"
   client_secret ="CLIENT_SECRET"
   

6. 要执行API调用，您将使用本包中的LexMachinaClient。这将在稍后详细讨论。

   对于这些中的每一个，您首先创建对象，然后在该对象上调用函数。

Lex Machina客户端

LexMachinaClient对象是与Lex Machina API交互的主要方式。

实例化LexMachinaClient对象

如果构造函数中没有参数，将从之前创建的config目录加载配置文件。

from lexmachina import LexMachinaClient

client = LexMachinaClient()

如果传递一个文件路径的字符串，将从该位置加载配置文件。

client = LexMachinaClient("../config/config.ini")

LexMachinaClient的GET函数

提供的功能分为几个类别

1. 资源列表
2. 按ID查找
3. 搜索

资源列表

这些函数都来自LexMachinaClient。每个函数都返回一个描述资源的JSON对象。

• LexMachinaClient.list_case_resolutions()
• LexMachinaClient.list_case_tags()
• LexMachinaClient.list_case_types()
• LexMachinaClient.list_courts()
• LexMachinaClient.list_damages()
• LexMachinaClient.list_events()
• LexMachinaClient.list_judgment_sources()

按ID(s)查找

这些函数都来自LexMachinaClient。每个函数都接受一个整数或最多100个整数的数组，其中参数是该记录的Lex Machina ID。它将返回一个表示该类型记录数据的JSON对象或对象数组。

• LexMachinaClient.get_attorneys()
• LexMachinaClient.get_district_cases()
• LexMachinaClient.get_federal_judges()
• LexMachinaClient.get_law_firms()
• LexMachinaClient.get_magistrates()
• LexMachinaClient.get_parties()
• LexMachinaClient.get_patents()