birdrecord-cli 0.1.0__tar.gz

birdrecord_cli-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 yoshino-s
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

birdrecord_cli-0.1.0/PKG-INFO

@@ -0,0 +1,102 @@
+Metadata-Version: 2.4
+Name: birdrecord-cli
+Version: 0.1.0
+Summary: CLI for China Bird Record (birdreport.cn); default API host weixin.birdrecord.cn (single-file main.py + uv).
+Author: yoshino-s
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/yoshino-s/birdrecord-cli
+Project-URL: Repository, https://github.com/yoshino-s/birdrecord-cli
+Project-URL: Documentation, https://github.com/yoshino-s/birdrecord-cli#readme
+Project-URL: Issues, https://github.com/yoshino-s/birdrecord-cli/issues
+Project-URL: Changelog, https://github.com/yoshino-s/birdrecord-cli/releases
+Project-URL: PyPI, https://pypi.org/project/birdrecord-cli/
+Keywords: birdrecord,birding,cli,weixin,miniprogram,httpx,click
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Internet :: WWW/HTTP
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: click>=8.1.0
+Requires-Dist: httpx>=0.28.1
+Requires-Dist: pycryptodome>=3.21.0
+Requires-Dist: pydantic>=2.10.0
+Requires-Dist: pypinyin>=0.53.0
+Dynamic: license-file
+
+# Birdrecord CLI
+
+CLI for the [Birdrecord](https://www.birdreport.cn/) / China Bird Record mini-program API. HTTP defaults to API host `https://weixin.birdrecord.cn` (override with `--base-url`); the [portal site](https://www.birdreport.cn/) is separate.
+
+**Species taxonomy**: Checklist entries, names, and `taxonid` values match the app and follow **Zheng 4**—the 4th edition of *A Checklist of the Birds of China* (中国鸟类分类与分布名录·第四版, “郑四”).
+
+## Install from PyPI
+
+Requires **Python 3.12+**.
+
+```bash
+pip install birdrecord-cli
+# or: uv tool install birdrecord-cli
+birdrecord-cli --help
+```
+
+Package index: [pypi.org/project/birdrecord-cli](https://pypi.org/project/birdrecord-cli/).
+
+## Run with uvx (no prior install)
+
+[uv](https://docs.astral.sh/uv/) downloads the package into an ephemeral environment. Pin the version for reproducible behavior:
+
+```bash
+uvx --from 'birdrecord-cli==0.1.0' birdrecord-cli --help
+uvx --from 'birdrecord-cli==0.1.0' birdrecord-cli provinces --pretty
+```
+
+Use the latest release version from PyPI if it differs from the example above.
+
+## Single-file + uv (no install)
+
+[PEP 723](https://peps.python.org/pep-0723/) script; [uv](https://docs.astral.sh/uv/) installs deps automatically.
+
+```bash
+curl -fsSL -o main.py 'https://raw.githubusercontent.com/yoshino-s/birdrecord-cli/main/main.py'
+uv run main.py --help
+```
+
+For a fork, change `yoshino-s` and/or `main` in the URL.
+
+## Usage
+
+Shared flags: `--token`, `--base-url`, `--no-verify`, `--timeout`, `--pretty`, `--envelope`. Subcommands: `provinces`, `cities`, `taxon`, `report`, `search`; most support `--schema`. `search` accepts optional `--taxon` / `--report` for activity drill-down; stdout JSON shapes are described in [docs/CLI.md](docs/CLI.md) under **`search` output (JSON)**. Full copied `--help` text: [docs/CLI.md](docs/CLI.md).
+
+```bash
+birdrecord-cli provinces --pretty
+birdrecord-cli report --id 1948816 --pretty
+birdrecord-cli search --body-json '{"startTime":"2026-02-24","endTime":"2026-03-24","province":"河北省","taxonid":4148,"version":"CH4"}' --pretty
+```
+
+(With `uv run main.py`, use the same subcommands after `uv run main.py`.)
+
+Environment variables:
+
+- `BIRDRECORD_CACHE_DIR`: optional taxon cache root (`…/taxon`); if unset, `$XDG_CACHE_HOME/birdrecord/taxon` when `XDG_CACHE_HOME` is set, else `~/.cache/birdrecord/taxon`.
+- `BIRDRECORD_CLI_CN`: any truthy value (not `0` / `false` / `no` / `off`) uses Chinese JSON Schema descriptions (e.g. `--schema`).
+
+## Demo
+
+![birdrecord-cli demo](docs/birdrecord-demo.gif)
+
+## Development
+
+Clone, then `uv sync --group dev && uv run pytest tests/ -v` (some tests hit the live API; some use `verify=False`). Tests import via [`birdrecord_client.py`](./birdrecord_client.py).
+
+## License
+
+MIT — see [LICENSE](LICENSE).
+
+---
+
+**中文说明**：[README.zh-CN.md](./README.zh-CN.md)

birdrecord_cli-0.1.0/README.md

@@ -0,0 +1,72 @@
+# Birdrecord CLI
+
+CLI for the [Birdrecord](https://www.birdreport.cn/) / China Bird Record mini-program API. HTTP defaults to API host `https://weixin.birdrecord.cn` (override with `--base-url`); the [portal site](https://www.birdreport.cn/) is separate.
+
+**Species taxonomy**: Checklist entries, names, and `taxonid` values match the app and follow **Zheng 4**—the 4th edition of *A Checklist of the Birds of China* (中国鸟类分类与分布名录·第四版, “郑四”).
+
+## Install from PyPI
+
+Requires **Python 3.12+**.
+
+```bash
+pip install birdrecord-cli
+# or: uv tool install birdrecord-cli
+birdrecord-cli --help
+```
+
+Package index: [pypi.org/project/birdrecord-cli](https://pypi.org/project/birdrecord-cli/).
+
+## Run with uvx (no prior install)
+
+[uv](https://docs.astral.sh/uv/) downloads the package into an ephemeral environment. Pin the version for reproducible behavior:
+
+```bash
+uvx --from 'birdrecord-cli==0.1.0' birdrecord-cli --help
+uvx --from 'birdrecord-cli==0.1.0' birdrecord-cli provinces --pretty
+```
+
+Use the latest release version from PyPI if it differs from the example above.
+
+## Single-file + uv (no install)
+
+[PEP 723](https://peps.python.org/pep-0723/) script; [uv](https://docs.astral.sh/uv/) installs deps automatically.
+
+```bash
+curl -fsSL -o main.py 'https://raw.githubusercontent.com/yoshino-s/birdrecord-cli/main/main.py'
+uv run main.py --help
+```
+
+For a fork, change `yoshino-s` and/or `main` in the URL.
+
+## Usage
+
+Shared flags: `--token`, `--base-url`, `--no-verify`, `--timeout`, `--pretty`, `--envelope`. Subcommands: `provinces`, `cities`, `taxon`, `report`, `search`; most support `--schema`. `search` accepts optional `--taxon` / `--report` for activity drill-down; stdout JSON shapes are described in [docs/CLI.md](docs/CLI.md) under **`search` output (JSON)**. Full copied `--help` text: [docs/CLI.md](docs/CLI.md).
+
+```bash
+birdrecord-cli provinces --pretty
+birdrecord-cli report --id 1948816 --pretty
+birdrecord-cli search --body-json '{"startTime":"2026-02-24","endTime":"2026-03-24","province":"河北省","taxonid":4148,"version":"CH4"}' --pretty
+```
+
+(With `uv run main.py`, use the same subcommands after `uv run main.py`.)
+
+Environment variables:
+
+- `BIRDRECORD_CACHE_DIR`: optional taxon cache root (`…/taxon`); if unset, `$XDG_CACHE_HOME/birdrecord/taxon` when `XDG_CACHE_HOME` is set, else `~/.cache/birdrecord/taxon`.
+- `BIRDRECORD_CLI_CN`: any truthy value (not `0` / `false` / `no` / `off`) uses Chinese JSON Schema descriptions (e.g. `--schema`).
+
+## Demo
+
+![birdrecord-cli demo](docs/birdrecord-demo.gif)
+
+## Development
+
+Clone, then `uv sync --group dev && uv run pytest tests/ -v` (some tests hit the live API; some use `verify=False`). Tests import via [`birdrecord_client.py`](./birdrecord_client.py).
+
+## License
+
+MIT — see [LICENSE](LICENSE).
+
+---
+
+**中文说明**：[README.zh-CN.md](./README.zh-CN.md)

birdrecord_cli-0.1.0/birdrecord_cli.egg-info/PKG-INFO

@@ -0,0 +1,102 @@
+Metadata-Version: 2.4
+Name: birdrecord-cli
+Version: 0.1.0
+Summary: CLI for China Bird Record (birdreport.cn); default API host weixin.birdrecord.cn (single-file main.py + uv).
+Author: yoshino-s
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/yoshino-s/birdrecord-cli
+Project-URL: Repository, https://github.com/yoshino-s/birdrecord-cli
+Project-URL: Documentation, https://github.com/yoshino-s/birdrecord-cli#readme
+Project-URL: Issues, https://github.com/yoshino-s/birdrecord-cli/issues
+Project-URL: Changelog, https://github.com/yoshino-s/birdrecord-cli/releases
+Project-URL: PyPI, https://pypi.org/project/birdrecord-cli/
+Keywords: birdrecord,birding,cli,weixin,miniprogram,httpx,click
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Internet :: WWW/HTTP
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: click>=8.1.0
+Requires-Dist: httpx>=0.28.1
+Requires-Dist: pycryptodome>=3.21.0
+Requires-Dist: pydantic>=2.10.0
+Requires-Dist: pypinyin>=0.53.0
+Dynamic: license-file
+
+# Birdrecord CLI
+
+CLI for the [Birdrecord](https://www.birdreport.cn/) / China Bird Record mini-program API. HTTP defaults to API host `https://weixin.birdrecord.cn` (override with `--base-url`); the [portal site](https://www.birdreport.cn/) is separate.
+
+**Species taxonomy**: Checklist entries, names, and `taxonid` values match the app and follow **Zheng 4**—the 4th edition of *A Checklist of the Birds of China* (中国鸟类分类与分布名录·第四版, “郑四”).
+
+## Install from PyPI
+
+Requires **Python 3.12+**.
+
+```bash
+pip install birdrecord-cli
+# or: uv tool install birdrecord-cli
+birdrecord-cli --help
+```
+
+Package index: [pypi.org/project/birdrecord-cli](https://pypi.org/project/birdrecord-cli/).
+
+## Run with uvx (no prior install)
+
+[uv](https://docs.astral.sh/uv/) downloads the package into an ephemeral environment. Pin the version for reproducible behavior:
+
+```bash
+uvx --from 'birdrecord-cli==0.1.0' birdrecord-cli --help
+uvx --from 'birdrecord-cli==0.1.0' birdrecord-cli provinces --pretty
+```
+
+Use the latest release version from PyPI if it differs from the example above.
+
+## Single-file + uv (no install)
+
+[PEP 723](https://peps.python.org/pep-0723/) script; [uv](https://docs.astral.sh/uv/) installs deps automatically.
+
+```bash
+curl -fsSL -o main.py 'https://raw.githubusercontent.com/yoshino-s/birdrecord-cli/main/main.py'
+uv run main.py --help
+```
+
+For a fork, change `yoshino-s` and/or `main` in the URL.
+
+## Usage
+
+Shared flags: `--token`, `--base-url`, `--no-verify`, `--timeout`, `--pretty`, `--envelope`. Subcommands: `provinces`, `cities`, `taxon`, `report`, `search`; most support `--schema`. `search` accepts optional `--taxon` / `--report` for activity drill-down; stdout JSON shapes are described in [docs/CLI.md](docs/CLI.md) under **`search` output (JSON)**. Full copied `--help` text: [docs/CLI.md](docs/CLI.md).
+
+```bash
+birdrecord-cli provinces --pretty
+birdrecord-cli report --id 1948816 --pretty
+birdrecord-cli search --body-json '{"startTime":"2026-02-24","endTime":"2026-03-24","province":"河北省","taxonid":4148,"version":"CH4"}' --pretty
+```
+
+(With `uv run main.py`, use the same subcommands after `uv run main.py`.)
+
+Environment variables:
+
+- `BIRDRECORD_CACHE_DIR`: optional taxon cache root (`…/taxon`); if unset, `$XDG_CACHE_HOME/birdrecord/taxon` when `XDG_CACHE_HOME` is set, else `~/.cache/birdrecord/taxon`.
+- `BIRDRECORD_CLI_CN`: any truthy value (not `0` / `false` / `no` / `off`) uses Chinese JSON Schema descriptions (e.g. `--schema`).
+
+## Demo
+
+![birdrecord-cli demo](docs/birdrecord-demo.gif)
+
+## Development
+
+Clone, then `uv sync --group dev && uv run pytest tests/ -v` (some tests hit the live API; some use `verify=False`). Tests import via [`birdrecord_client.py`](./birdrecord_client.py).
+
+## License
+
+MIT — see [LICENSE](LICENSE).
+
+---
+
+**中文说明**：[README.zh-CN.md](./README.zh-CN.md)

birdrecord_cli-0.1.0/birdrecord_cli.egg-info/SOURCES.txt

@@ -0,0 +1,12 @@
+LICENSE
+README.md
+birdrecord_client.py
+main.py
+pyproject.toml
+birdrecord_cli.egg-info/PKG-INFO
+birdrecord_cli.egg-info/SOURCES.txt
+birdrecord_cli.egg-info/dependency_links.txt
+birdrecord_cli.egg-info/entry_points.txt
+birdrecord_cli.egg-info/requires.txt
+birdrecord_cli.egg-info/top_level.txt
+tests/test_birdrecord_client.py

birdrecord_cli-0.1.0/birdrecord_cli.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

birdrecord_cli-0.1.0/birdrecord_cli.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+birdrecord-cli = main:main

birdrecord_cli-0.1.0/birdrecord_cli.egg-info/requires.txt

@@ -0,0 +1,5 @@
+click>=8.1.0
+httpx>=0.28.1
+pycryptodome>=3.21.0
+pydantic>=2.10.0
+pypinyin>=0.53.0

birdrecord_cli-0.1.0/birdrecord_cli.egg-info/top_level.txt

@@ -0,0 +1,2 @@
+birdrecord_client
+main

birdrecord_cli-0.1.0/birdrecord_client.py

@@ -0,0 +1,81 @@
+"""
+Re-export the Birdrecord client and models from ``main`` for tests and ``import birdrecord_client``.
+
+End users: install from PyPI (``pip install birdrecord-cli``) and run ``birdrecord-cli``; or use the
+single-file ``main.py`` workflow with ``uv run``.
+"""
+
+from __future__ import annotations
+
+from main import (
+    AdcodeCityRequest,
+    AdcodeProvinceRequest,
+    BirdrecordClient,
+    CityRow,
+    ChartActivityReportRow,
+    ChartActivityTaxonRow,
+    CommonChartBundleGrouped,
+    CommonListActivityTaxonRequest,
+    CommonPageActivityRequest,
+    DEFAULT_TAXON_VERSION,
+    DubiousAccurateCounts,
+    MemberProfilePayload,
+    MonthSearchEntry,
+    PointDetailPayload,
+    ProvinceRow,
+    RecordSummaryPayload,
+    RecordSummaryRequest,
+    RegionChartQueryBody,
+    ReportBundleResult,
+    ReportDetailPayload,
+    ReportGetRequest,
+    SearchStatisticResult,
+    StandardApiEnvelope,
+    TaxonMonthSlice,
+    TaxonRow,
+    TaxonSearchRequest,
+    build_common_list_taxon_request,
+    build_common_page_activity_request,
+    coerce_common_activity_body,
+    filter_region_rows_by_query,
+    filter_taxon_rows_by_query,
+)
+
+from main import _load_taxon_search_disk as _load_taxon_search_disk
+from main import _save_taxon_search_disk as _save_taxon_search_disk
+
+__all__ = [
+    "AdcodeCityRequest",
+    "AdcodeProvinceRequest",
+    "BirdrecordClient",
+    "CityRow",
+    "ChartActivityReportRow",
+    "ChartActivityTaxonRow",
+    "CommonChartBundleGrouped",
+    "CommonListActivityTaxonRequest",
+    "CommonPageActivityRequest",
+    "DEFAULT_TAXON_VERSION",
+    "DubiousAccurateCounts",
+    "MemberProfilePayload",
+    "MonthSearchEntry",
+    "PointDetailPayload",
+    "ProvinceRow",
+    "RecordSummaryPayload",
+    "RecordSummaryRequest",
+    "RegionChartQueryBody",
+    "ReportBundleResult",
+    "ReportDetailPayload",
+    "ReportGetRequest",
+    "SearchStatisticResult",
+    "StandardApiEnvelope",
+    "TaxonMonthSlice",
+    "TaxonRow",
+    "TaxonSearchRequest",
+    "_load_taxon_search_disk",
+    "_save_taxon_search_disk",
+    "build_common_list_taxon_request",
+    "build_common_page_activity_request",
+    "coerce_common_activity_body",
+    "filter_region_rows_by_query",
+    "filter_taxon_rows_by_query",
+]