Skip to main content

Alpha 法律数据查询命令行工具(案例 / 法规 / 实务文章)

Project description

alphadata-cli

Alpha 法律数据查询命令行工具。封装案例、法规、实务文章三大数据接口,提供统一的 alphadata 命令行入口。

  • 🔑 两级鉴权:API Key 持久化(环境变量 / 配置文件),Token 自动换取并缓存(内存级缓存文件,权限 600)
  • 🌳 字段表内置:按需查询字段表,避免一次性拉取撑爆上下文
  • 🧩 结构化查询:传入英文参数 + 中文值,CLI 自动查字段表拼查询字符串(支持多级层级自动判断、code 映射)
  • 🪶 零第三方依赖:纯 Python 标准库实现(urllib / argparse / json)

安装

pip install alphadata-cli

安装后即获得 alphadata 命令。

要求 Python 3.8+。

快速开始

1. 配置 API Key

alphadata auth login --api-key ak_xxx

API Key 会保存到 ~/.alpha/config.json,Token 缓存到 ~/.alpha/.token(权限 600,30 天有效)。

也可通过环境变量配置:

export ALPHADATA_API_KEY=ak_xxx

2. 查询

# 法规:先查专题字段,再查
alphadata law fields --topic --search 股权
alphadata law search --topic 股权代持 --validity 现行有效

# 案例:结构化参数,CLI 自动判层级
alphadata case search --cause 民事 --court_level 最高人民法院
alphadata case search --court_view "诈骗 自首" --region 北京市

# 实务文章
alphadata article search --topic 公司法 --publish_time 近三个月

3. 详情

alphadata law detail --lid <法规ID> --title 民法典 --article 1
alphadata case detail --jid <案例ID>
alphadata article detail --aid <文章ID>

命令总览

alphadata
├── case      案例查询(search / detail / fields)
├── law       法规查询(search / detail / fields)
├── article   实务文章查询(search / detail / fields)
└── auth      鉴权管理(login / status / logout)

鉴权流程

API Key (持久化)  →  换取 Token (缓存)  →  Token 鉴权查询数据
                          ↑                       │
                          └── 过期/失效自动重换 ←──┘
  • API Key:持久存储在 ~/.alpha/config.json 和环境变量 ALPHADATA_API_KEY
  • Token:仅在本地缓存文件中,自动管理,关机/过期后自动用 API Key 重新换取

结构化查询

search 子命令支持两种查询方式:

  1. 结构化参数(推荐):英文 flag + 中文值,CLI 自动查字段表拼查询字符串

    alphadata law search --topic 股权代持 --validity 现行有效
    # CLI 自动拼成: Alpha实务专题_3:股权代持,时效性_1:现行有效
    
  2. 原始查询(兜底):直接透传,跳过字段校验

    alphadata law search --query "全文_99:民法典"
    

开发

本项目采用标准 Python 包结构(src layout):

# 本地开发安装
pip install -e .

# 构建
pip install build
python -m build

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

alphadata_cli-0.1.0.dev1.tar.gz (172.5 kB view details)

Uploaded Source

Built Distribution

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

alphadata_cli-0.1.0.dev1-py3-none-any.whl (185.4 kB view details)

Uploaded Python 3

File details

Details for the file alphadata_cli-0.1.0.dev1.tar.gz.

File metadata

  • Download URL: alphadata_cli-0.1.0.dev1.tar.gz
  • Upload date:
  • Size: 172.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.13

File hashes

Hashes for alphadata_cli-0.1.0.dev1.tar.gz
Algorithm Hash digest
SHA256 c3f4cae26d009ad502c4d38c8e4231cb15d1d05440ccc6f84d26d3cf4d4ea5b4
MD5 6eeed9f4c519a2187e8cdbafe4a0cf1d
BLAKE2b-256 a218be86ac98c783ac8049740f480535c2c259fa293d851e89687853e1882a23

See more details on using hashes here.

File details

Details for the file alphadata_cli-0.1.0.dev1-py3-none-any.whl.

File metadata

File hashes

Hashes for alphadata_cli-0.1.0.dev1-py3-none-any.whl
Algorithm Hash digest
SHA256 83bf1488d7c01bc1f9f4b989132e60f48c7bbe2973fe481d4cef434a29841e28
MD5 6758290502dbeb3ab7b79529c805748a
BLAKE2b-256 620d36c8461af9e898da9ec75fabc8bdfc0daf7a80f4dfb615e91cabba1f5c70

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page