isdn-python/README.md

65 lines
1.4 KiB
Markdown
Raw Normal View History

2023-03-26 04:57:18 +09:00
# ISDN-Python
2023-04-03 03:04:01 +09:00
[![PyPI version](https://badge.fury.io/py/isdn.svg)](https://badge.fury.io/py/isdn)
[![Test](https://github.com/Babibubebon/isdn-python/actions/workflows/test.yml/badge.svg)](https://github.com/Babibubebon/isdn-python/actions/workflows/test.yml)
2023-03-26 04:57:18 +09:00
[ISDN (International Standard Dojin Numbering)](https://isdn.jp/) のPythonライブラリとCLIツール
## Install
```
$ pip install isdn
```
## Example
2023-04-03 03:04:01 +09:00
ISDNを[番号の仕様](https://isdn.jp/about.html)に従って検証
2023-03-26 04:57:18 +09:00
```python
>>> from isdn import ISDN
>>> isdn = ISDN("2784702901978")
>>> isdn.validate()
True
>>> ISDN.calc_check_digit("2784702901978")
'8'
```
2023-04-03 03:04:01 +09:00
isdn.jp が提供している書誌情報を取得 ([Web からの情報取得](https://isdn.jp/about.html))
2023-03-26 04:57:18 +09:00
```python
>>> from isdn import ISDNClient
>>> client = ISDNClient()
>>> record = client.get("2784702901978")
>>> record.isdn
ISDN(code='2784702901978', prefix='278', group='4', registrant='702901', publication='97', check_digit='8')
>>> record.product_name
'みほん同人誌'
```
## CLI
指定したISDNの形式を検証
```
$ isdn validate 2784702901978
```
指定したISDNの書誌情報を isdn.jp から取得
```
$ isdn get 2784702901978
$ isdn get 2784702901978 --format json
```
ISDNの一覧を isdn.jp から取得
```
$ isdn list
```
すべての書誌情報を isdn.jp から取得してファイルに保存
```
$ isdn bulk-download /path/to/download
```