yandex-audience-cli
CLI для Yandex Audience API, повторяющий структуру API «1 в 1» с гарантией 100% покрытия эндпоинтов.
📖 Документация: https://axisrow.github.io/yandex-audience-cli/
Структура API (3 уровня)
версия (v1) → пространство (management) → ресурс (5 групп)
База: https://api-audience.yandex.ru/v1/management. Авторизация: заголовок Authorization: OAuth <token>.
WSDL неприменим (REST/JSON, не SOAP). Реестр выверен 1:1 по официальному
OpenAPI-справочнику Яндекса; единый источник правды —
пакет yac/registry/ (файл на эндпоинт; 28 эндпоинтов в 5 группах).
Раскладка
Весь код — в пакете yac/. Имена модулей живут в namespace yac.*, поэтому
не конфликтуют с чужими top-level модулями в глобальном sys.path (без venv и без
префиксов). Структура:
yac/
├── __init__.py # реэкспорт app, __version__
├── __main__.py # python -m yac
├── cli.py # сборка корневого Typer-приложения
├── config.py client.py models.py
├── base.py context.py render.py inputs.py output.py
├── registry/ # реестр-дерево: подкаталог на группу, файл на эндпоинт
│ ├── _core.py # Endpoint, GROUPS, автосборка ENDPOINTS
│ └── segments/ grants/ pixels/ accounts/ delegates/
├── api/ # HTTP-классы ресурсов, по файлу на группу
│ └── segments.py grants.py pixels.py accounts.py delegates.py
└── commands/ # Typer-команды, по файлу на группу
└── segments.py grants.py pixels.py accounts.py delegates.py
По каждой группе API — пара api/<group>.py (HTTP-вызовы) и commands/<group>.py
(команды Typer).
| Группа | Эндпоинтов | Команды |
|---|---|---|
segments |
16 | list, create-pixel, create-lookalike, create-metrika, create-appmetrica, create-geo, create-geo-polygon, upload-file, upload-csv-file, update-geo-points, modify-data, confirm, confirm-client-id, update, delete, reprocess |
grants |
3 | list, add, remove |
pixels |
5 | list, create, update, delete, undelete |
accounts |
1 | list |
delegates |
3 | list, add, remove |
Метод «получить один сегмент» (
GET segment/{id}) в Audience API отсутствует — по официальному справочнику доступен только список (GET segments). Поэтому такой команды нет.
Установка
pip install -e ".[dev]"
Токен
Любой из способов (по приоритету): --token <OAUTH> → env YANDEX_AUDIENCE_TOKEN →
файл ~/.config/yandex-audience-cli/token. Шаблон переменных — .env.example.
Где взять токен, как работать с .env и про общие права приложения — см.
Аутентификация.
Примеры
yac segments list
yac -o table segments list --pixel 12345 # глобальная -o ДО группы
yac segments create-pixel --data '{"name":"my","pixel_id":1,"period_length":30}'
yac segments create-pixel --data @segment.json # из файла
yac pixels create --name "Мой пиксель"
yac grants add 777 --user-login partner@yandex.ru --comment "доступ"
yac delegates list
Глобальные опции: --token, --base-url, -o/--output json|table, --pretty, --version.
Гарантия покрытия
tests/unit/test_registry_coverage.py падает, если в реестре есть эндпоинт без соответствующего
метода ресурса или команды CLI. Это машинная проверка структурного соответствия API.
pytest
Боевой smoke-прогон
scripts/live_smoke.sh гоняет все 28 эндпоинтов через настоящий yac на боевом Audience API
(в отличие от read-only tests/e2e/test_live_api.py). ⚠️ Скрипт мутирует боевой аккаунт: создаёт
и удаляет реальные объекты (с префиксом SMOKE yac), но самоочищается через trap EXIT — работает
только на своих данных, чужие сегменты не трогает. В CI не запускается (нужен реальный токен и квота
записи). Запуск: токен в .env, затем bash scripts/live_smoke.sh. Подробнее —
Разработка.
Metadata
Release files for yandex-audience-cli 0.1.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| yandex_audience_cli-0.1.1.tar.gz | 65.0 kB | Without provenance | Details for yandex_audience_cli-0.1.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| yandex_audience_cli-0.1.1-py3-none-any.whl | Python 3 | none | any | Details for yandex_audience_cli-0.1.1-py3-none-any.whl |
Total release size: 107.8 kB
Release files / yandex_audience_cli-0.1.1.tar.gz
| Download URL | yandex_audience_cli-0.1.1.tar.gz |
|---|---|
| Size | 65.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
4197666ab3577fd4188cf2aecdc9b5bc95ee0ed07bc769e277e4ecdcfcbd679c
|
|
BLAKE2b-256 checksum How to use checksums |
b6c3d5dd029f5838775a5c77e249d01b6872306ceb42752a46c7af105b29b640
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.15
|
Release files / yandex_audience_cli-0.1.1-py3-none-any.whl
| Download URL | yandex_audience_cli-0.1.1-py3-none-any.whl |
|---|---|
| Size | 42.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
ef3dbcca3911bb29d5092b3e295eed76548c50c341f1d3c0e5d3b6976b05b61d
|
|
BLAKE2b-256 checksum How to use checksums |
47a04845c86a9ed57ca30f13562b1e1a6690a93d1917afdec423439771f49b89
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.15
|
Security for yandex-audience-cli 0.1.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.