Metadata-Version: 2.4
Name: pydomi
Version: 0.1.3
Summary: Python SDK for DOM.Inventory CMDB — typed REST client with bulk, async, OPTIONS-introspection and OpenAPI-driven codegen.
Author: DOM.Inventory team
Maintainer: DOM.Inventory team
License: 
                                         Apache License
                                   Version 2.0, January 2004
                                http://www.apache.org/licenses/
        
           TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
        
           1. Definitions.
        
              "License" shall mean the terms and conditions for use, reproduction,
              and distribution as defined by Sections 1 through 9 of this document.
        
              "Licensor" shall mean the copyright owner or entity authorized by
              the copyright owner that is granting the License.
        
              "Legal Entity" shall mean the union of the acting entity and all
              other entities that control, are controlled by, or are under common
              control with that entity. For the purposes of this definition,
              "control" means (i) the power, direct or indirect, to cause the
              direction or management of such entity, whether by contract or
              otherwise, or (ii) ownership of fifty percent (50%) or more of the
              outstanding shares, or (iii) beneficial ownership of such entity.
        
              "You" (or "Your") shall mean an individual or Legal Entity
              exercising permissions granted by this License.
        
              "Source" form shall mean the preferred form for making modifications,
              including but not limited to software source code, documentation
              source, and configuration files.
        
              "Object" form shall mean any form resulting from mechanical
              transformation or translation of a Source form, including but
              not limited to compiled object code, generated documentation,
              and conversions to other media types.
        
              "Work" shall mean the work of authorship, whether in Source or
              Object form, made available under the License, as indicated by a
              copyright notice that is included in or attached to the work
              (an example is provided in the Appendix below).
        
              "Derivative Works" shall mean any work, whether in Source or Object
              form, that is based on (or derived from) the Work and for which the
              editorial revisions, annotations, elaborations, or other modifications
              represent, as a whole, an original work of authorship. For the purposes
              of this License, Derivative Works shall not include works that remain
              separable from, or merely link (or bind by name) to the interfaces of,
              the Work and Derivative Works thereof.
        
              "Contribution" shall mean any work of authorship, including
              the original version of the Work and any modifications or additions
              to that Work or Derivative Works thereof, that is intentionally
              submitted to Licensor for inclusion in the Work by the copyright owner
              or by an individual or Legal Entity authorized to submit on behalf of
              the copyright owner. For the purposes of this definition, "submitted"
              means any form of electronic, verbal, or written communication sent
              to the Licensor or its representatives, including but not limited to
              communication on electronic mailing lists, source code control systems,
              and issue tracking systems that are managed by, or on behalf of, the
              Licensor for the purpose of discussing and improving the Work, but
              excluding communication that is conspicuously marked or otherwise
              designated in writing by the copyright owner as "Not a Contribution."
        
              "Contributor" shall mean Licensor and any individual or Legal Entity
              on behalf of whom a Contribution has been received by Licensor and
              subsequently incorporated within the Work.
        
           2. Grant of Copyright License. Subject to the terms and conditions of
              this License, each Contributor hereby grants to You a perpetual,
              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
              copyright license to reproduce, prepare Derivative Works of,
              publicly display, publicly perform, sublicense, and distribute the
              Work and such Derivative Works in Source or Object form.
        
           3. Grant of Patent License. Subject to the terms and conditions of
              this License, each Contributor hereby grants to You a perpetual,
              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
              (except as stated in this section) patent license to make, have made,
              use, offer to sell, sell, import, and otherwise transfer the Work,
              where such license applies only to those patent claims licensable
              by such Contributor that are necessarily infringed by their
              Contribution(s) alone or by combination of their Contribution(s)
              with the Work to which such Contribution(s) was submitted. If You
              institute patent litigation against any entity (including a
              cross-claim or counterclaim in a lawsuit) alleging that the Work
              or a Contribution incorporated within the Work constitutes direct
              or contributory patent infringement, then any patent licenses
              granted to You under this License for that Work shall terminate
              as of the date such litigation is filed.
        
           4. Redistribution. You may reproduce and distribute copies of the
              Work or Derivative Works thereof in any medium, with or without
              modifications, and in Source or Object form, provided that You
              meet the following conditions:
        
              (a) You must give any other recipients of the Work or
                  Derivative Works a copy of this License; and
        
              (b) You must cause any modified files to carry prominent notices
                  stating that You changed the files; and
        
              (c) You must retain, in the Source form of any Derivative Works
                  that You distribute, all copyright, patent, trademark, and
                  attribution notices from the Source form of the Work,
                  excluding those notices that do not pertain to any part of
                  the Derivative Works; and
        
              (d) If the Work includes a "NOTICE" text file as part of its
                  distribution, then any Derivative Works that You distribute must
                  include a readable copy of the attribution notices contained
                  within such NOTICE file, excluding those notices that do not
                  pertain to any part of the Derivative Works, in at least one
                  of the following places: within a NOTICE text file distributed
                  as part of the Derivative Works; within the Source form or
                  documentation, if provided along with the Derivative Works; or,
                  within a display generated by the Derivative Works, if and
                  wherever such third-party notices normally appear. The contents
                  of the NOTICE file are for informational purposes only and
                  do not modify the License. You may add Your own attribution
                  notices within Derivative Works that You distribute, alongside
                  or as an addendum to the NOTICE text from the Work, provided
                  that such additional attribution notices cannot be construed
                  as modifying the License.
        
              You may add Your own copyright statement to Your modifications and
              may provide additional or different license terms and conditions
              for use, reproduction, or distribution of Your modifications, or
              for any such Derivative Works as a whole, provided Your use,
              reproduction, and distribution of the Work otherwise complies with
              the conditions stated in this License.
        
           5. Submission of Contributions. Unless You explicitly state otherwise,
              any Contribution intentionally submitted for inclusion in the Work
              by You to the Licensor shall be under the terms and conditions of
              this License, without any additional terms or conditions.
              Notwithstanding the above, nothing herein shall supersede or modify
              the terms of any separate license agreement you may have executed
              with Licensor regarding such Contributions.
        
           6. Trademarks. This License does not grant permission to use the trade
              names, trademarks, service marks, or product names of the Licensor,
              except as required for reasonable and customary use in describing the
              origin of the Work and reproducing the content of the NOTICE file.
        
           7. Disclaimer of Warranty. Unless required by applicable law or
              agreed to in writing, Licensor provides the Work (and each
              Contributor provides its Contributions) on an "AS IS" BASIS,
              WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
              implied, including, without limitation, any warranties or conditions
              of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
              PARTICULAR PURPOSE. You are solely responsible for determining the
              appropriateness of using or redistributing the Work and assume any
              risks associated with Your exercise of permissions under this License.
        
           8. Limitation of Liability. In no event and under no legal theory,
              whether in tort (including negligence), contract, or otherwise,
              unless required by applicable law (such as deliberate and grossly
              negligent acts) or agreed to in writing, shall any Contributor be
              liable to You for damages, including any direct, indirect, special,
              incidental, or consequential damages of any character arising as a
              result of this License or out of the use or inability to use the
              Work (including but not limited to damages for loss of goodwill,
              work stoppage, computer failure or malfunction, or any and all
              other commercial damages or losses), even if such Contributor
              has been advised of the possibility of such damages.
        
           9. Accepting Warranty or Additional Liability. While redistributing
              the Work or Derivative Works thereof, You may choose to offer,
              and charge a fee for, acceptance of support, warranty, indemnity,
              or other liability obligations and/or rights consistent with this
              License. However, in accepting such obligations, You may act only
              on Your own behalf and on Your sole responsibility, not on behalf
              of any other Contributor, and only if You agree to indemnify,
              defend, and hold each Contributor harmless for any liability
              incurred by, or claims asserted against, such Contributor by reason
              of your accepting any such warranty or additional liability.
        
           END OF TERMS AND CONDITIONS
        
           APPENDIX: How to apply the Apache License to your work.
        
              To apply the Apache License to your work, attach the following
              boilerplate notice, with the fields enclosed by brackets "[]"
              replaced with your own identifying information. (Don't include
              the brackets!)  The text should be enclosed in the appropriate
              comment syntax for the file format. We also recommend that a
              file or class name and description of purpose be included on the
              same "printed page" as the copyright notice for easier
              identification within third-party archives.
        
           Copyright [yyyy] [name of copyright owner]
        
           Licensed under the Apache License, Version 2.0 (the "License");
           you may not use this file except in compliance with the License.
           You may obtain a copy of the License at
        
               http://www.apache.org/licenses/LICENSE-2.0
        
           Unless required by applicable law or agreed to in writing, software
           distributed under the License is distributed on an "AS IS" BASIS,
           WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
           See the License for the specific language governing permissions and
           limitations under the License.
        
Project-URL: Homepage, https://github.com/dom-inventory/pydomi
Project-URL: Documentation, https://github.com/dom-inventory/pydomi#readme
Project-URL: Source, https://github.com/dom-inventory/pydomi
Project-URL: Issues, https://github.com/dom-inventory/pydomi/issues
Project-URL: Changelog, https://github.com/dom-inventory/pydomi/releases
Keywords: dom-inventory,cmdb,rest,sdk,ipam,dcim,openapi
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: System Administrators
Classifier: Intended Audience :: Information Technology
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: System :: Networking
Classifier: Topic :: System :: Systems Administration
Classifier: Typing :: Typed
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: requests<3.0,>=2.31
Provides-Extra: async
Requires-Dist: httpx<1.0,>=0.27; extra == "async"
Provides-Extra: dev
Requires-Dist: pytest<9.0,>=8.0; extra == "dev"
Requires-Dist: pytest-asyncio<1.0,>=0.23; extra == "dev"
Requires-Dist: responses<1.0,>=0.25; extra == "dev"
Requires-Dist: respx<1.0,>=0.21; extra == "dev"
Requires-Dist: httpx<1.0,>=0.27; extra == "dev"
Requires-Dist: ruff<1.0,>=0.5; extra == "dev"
Requires-Dist: build<2.0,>=1.2; extra == "dev"
Requires-Dist: twine<7.0,>=6.1; extra == "dev"
Provides-Extra: docs
Requires-Dist: sphinx>=7.0; extra == "docs"
Requires-Dist: sphinx-rtd-theme>=2.0; extra == "docs"
Requires-Dist: myst-parser>=2.0; extra == "docs"
Dynamic: license-file

# pydomi — Python SDK для DOM.Inventory

Идиоматичный клиент REST API: `api.<app>.<endpoint>.<verb>(...)`.
Полный CRUD, bulk-операции, async-вариант, OPTIONS-introspection,
автогенерация типизированных классов из OpenAPI-схемы.

```python
import pydomi

api = pydomi.Api("http://your-server:8000", token="<api-token>")

# список — авто-пагинация
for device in api.dcim.devices.filter(site=1):
    print(device.id, device.name, device.serial)

# одиночный объект
site = api.dcim.sites.get(slug="dc-north")

# создание
new = api.dcim.sites.create(name="DC-South", slug="dc-south")

# редактирование
new.description = "Резервная площадка"
new.save()                  # PATCH только изменённых полей

# удаление
new.delete()
```

---

## Установка

```bash
pip install pydomi              # ядро
pip install pydomi[async]       # + httpx для AsyncApi
pip install pydomi[dev]         # + pytest, respx, twine
pip install pydomi[docs]        # + sphinx
```

Требования: Python ≥ 3.10, `requests ≥ 2.31`.

---

## Шаг 2 (важный): сгенерировать типизированные классы под ваш сервер

Сразу после установки запустите:

```bash
python -m pydomi update-classes http://your-server:8000 --token <api-token>
# или
pydomi update-classes http://your-server:8000 --token <api-token>
```

Команда:

1. Скачивает OpenAPI-схему с `/api/schema/`.
2. Генерирует **типизированные классы** для каждой модели в
   `pydomi/generated/models.py` + `.pyi` стабы для IDE-автодополнения.
3. Складывает метаданные (`FK_MAP`, `M2M_MAP`, `REVERSE_FK_MAP`,
   `READ_ONLY_FIELDS`, `ACTIONS_MAP`, `FILTERS_MAP`) в
   `pydomi/generated/__init__.py`.

После этого автоматически включаются:

| Фича | Что это даёт |
|------|--------------|
| **Типизированные классы** | `isinstance(dev, Device)`, IDE видит поля |
| **Lazy FK** | `dev.site.name` (один GET с кешем) вместо ручного `api.dcim.sites.get(dev.site)` |
| **M2M-менеджеры** | `dev.tags.add("prod")` / `.remove(...)` / `.set(...)` |
| **Reverse-FK** | `dev.interfaces.all()`, `site.devices.count()` |
| **Filter validation** | `filter(unknown_kwarg=X)` ловится `UserWarning` локально |
| **Strict-create** | `create(..., strict=True)` валидирует required / choices / max_length до POST |
| **Slug → id auto-resolve** | `create(site="dc-1")` сам резолвит FK |

> Запускайте `update-classes` снова после каждого расширения серверной модели —
> SDK сразу подхватит новые поля и endpoint'ы. `python -m pydomi diff` покажет
> diff между текущим `generated/` и тем, что отдаёт сервер.

Без этого шага SDK тоже работает, но в «динамическом» режиме: все объекты
будут `Record`, FK останутся `int`-ами, IDE-автодополнения не будет.

---

## Аутентификация

DOM.Inventory принимает три способа:

| Способ | Как передать |
|--------|--------------|
| **API-токен** (рекомендуется) | `pydomi.Api(url, token="...")` — отправит `Authorization: Token <key>` |
| **Session login** | `api.login(username, password)` — Django form login с CSRF, cookie в session |
| **Свой Session** | `pydomi.Api(url, session=<requests.Session>)` — для кастомных adapter'ов/auth |

Управление API-токенами **из SDK**:

```python
t = api.tokens.create("ci-bot")
print("STORE:", t["raw_key"])  # показывается ОДИН РАЗ

for t in api.tokens.list():
    print(t["id"], t["name"], t["prefix"], t["is_active"])

api.tokens.rotate(7)        # старый ключ моментально перестаёт работать
api.tokens.revoke(7)        # is_active=False, не удаляет
api.tokens.delete(7)        # hard delete
```

---

## Поддерживаемые приложения и эндпоинты

Список генерится из серверного OpenAPI-описания и кодифицирован в
`src/pydomi/registry.py`. После `update-classes` доступны:

| App | Endpoints |
|-----|-----------|
| `core` | `tags`, `statuses`, `custom_fields`, `custom_field_values`, `uniqueness_rules`, `audit_logs` (read-only), `auth_tokens` |
| `organizations` | `organizations` |
| `tenancy` | `tenant_groups`, `tenants`, `contacts` |
| `dcim` | `regions`, `sites`, `locations`, `racks`, `manufacturers`, `device_types`, `platforms`, `device_roles`, `cluster_types`, `clusters`, `devices` |
| `network` | `vrfs`, `prefix_roles`, `prefixes`, `interfaces`, `ip_addresses`, `nat_rules` |
| `virtualization` | `virtual_machines` |
| `circuits` | `providers`, `circuit_types`, `circuits` |
| `agents` | `agent_types`, `agents`, `health_check_rules` |
| `automated_systems` | `system_groups`, `automated_systems`, `auto_as_rules` |
| `ansible` | `connection_profiles`, `ansible_inventories` |
| `containers` | `registries`, `registry_proxies`, `repositories`, `images`, `containers` |
| `services` | `services`, `service_dependencies`, `dns_zones`, `dns_records`, `load_balancers`, `lb_vips`, `lb_backends` |

Из кода:

```python
api.apps()         # ['core', 'organizations', 'tenancy', 'dcim', …]
api.endpoints()    # {'dcim': ['clusters', 'devices', …], …}
```

---

## CRUD на каждый день

```python
# all() — лениво пагинируется
list(api.dcim.devices.all())

# filter / search / order_by / slicing / first / last / exists
api.dcim.devices.filter(site=1, status="active")
api.dcim.devices.search("router")
api.dcim.devices.order_by("-created_at")
api.dcim.devices.all()[:10]
api.dcim.devices.first()

# count — один запрос, без выгрузки страниц
api.dcim.devices.count(status="active")

# get(id) или get(**lookup)
api.dcim.devices.get(42)
api.dcim.devices.get(name="router-msk-1")

# create — slug→id auto-resolve для FK и стрип read-only
dev = api.dcim.devices.create(name="d1", device_type=1, site="dc-1")

# strict-проверка до POST: required / unknown / choices / max_length
dev = api.dcim.devices.create(name="d2", site=1, strict=True)

# save / update / refresh / delete
dev.serial = "ABC"
dev.save()
dev.update(serial="DEF", description="…")
dev.refresh()
dev.delete()

# diff — что я изменил до save()
dev.serial = "XYZ"
dev.diff()  # {'serial': ('ABC', 'XYZ')}

# describe — pretty-print для REPL / Jupyter
print(dev.describe())
```

---

## Bulk и атомарность

Серверная сторона предоставляет `bulk` / `bulk_update` / `bulk_delete` действия
на каждом ViewSet (`apps/api/bulk.py`). SDK использует их под капотом — это
**один HTTP-запрос на батч**, **обёрнутый в `transaction.atomic()` на сервере**.
Если хоть один элемент не валиден, БД откатится целиком.

```python
# bulk_create — один POST, один rollback при ошибке
created = api.core.tags.bulk_create([
    {"name": "prod", "slug": "prod", "color": "#FF0000"},
    {"name": "dev",  "slug": "dev",  "color": "#00FF00"},
])
# → [Record, Record], в порядке входа

# bulk_update — один PATCH с массивом, требует ``id`` в каждом item
api.dcim.devices.bulk_update([
    {"id": 1, "description": "edited"},
    {"id": 2, "description": "edited"},
])

# bulk_delete — один DELETE с {"ids": [...]}
api.dcim.devices.bulk_delete([1, 2, 3])
```

Cap размера батча — `1000` строк (override на сервере `bulk_max_items` per ViewSet).
Если на старом сервере bulk-эндпоинтов нет (404), SDK автоматически откатывается
на per-row цикл — параметр `fallback=False` отключает откат и пробрасывает ошибку.

**Скорость:** на тесте 50 объектов — `create` ×46, `delete` ×50 быстрее чем
последовательные POST/DELETE.

---

## Async

```python
import asyncio
from pydomi import AsyncApi

async def main():
    async with AsyncApi("http://your-server:8000", token=tk) as api:
        # три endpoint'а параллельно
        sites, devices, tags = await asyncio.gather(
            api.dcim.sites.all().all_list(),
            api.dcim.devices.all().all_list(),
            api.core.tags.all().all_list(),
        )

        # async iteration + auto-pagination
        async for dev in api.dcim.devices.search("router"):
            print(dev.id, dev.name)

asyncio.run(main())
```

Доступен после `pip install pydomi[async]` (тянет `httpx`).
Те же codegen-метаданные используются — `pydomi.AsyncApi` и `pydomi.Api`
работают с одним и тем же `pydomi/generated/`.

---

## Кеш справочников и dry-run

```python
api = pydomi.Api(
    "http://server",
    token=tk,
    cache_ttl=60,    # TTL-LRU кеш для GET-detail на справочниках
    dry_run=False,   # True → мутации логируются, не отправляются
)
```

`cache_ttl > 0` включает кеш для read-mostly endpoint'ов (Tag, Status, Site, Tenant,
AS и т.д.). Lazy-FK через `dev.site.name` тогда стоит один GET на ~5 минут, а не
сотни GET'ов при перебое устройств.

---

## Обработка ошибок

```python
from pydomi.exceptions import (
    AuthenticationError,   # 401, 403
    NotFoundError,         # 404
    ValidationError,       # 400 (DRF dict {field: [msg]})
    ThrottledError,        # 429 (есть .retry_after)
    RequestError,          # всё остальное / сетевая ошибка
    ConfigurationError,    # неправильное использование SDK
)

try:
    api.dcim.sites.create(name="dup", slug="dup")
except ValidationError as e:
    print(e.field_errors)        # {'slug': ['This field must be unique.']}
except ThrottledError as e:
    print("retry after", e.retry_after, "s")
```

Retry-policy для 5xx и 429 (с уважением `Retry-After`) включён по умолчанию
через `urllib3` Retry-adapter:

```python
pydomi.Api(url, retries=3, backoff_factor=0.3)
```

---

## CLI

```bash
pydomi update-classes <url>      # см. выше
pydomi diff                       # сравнить local generated/ с сервером
pydomi schema dump > schema.json  # сырая OpenAPI
pydomi get devices --filter site=1 --fields name,serial --format table
pydomi get devices 42 --format json
pydomi create tags name=prod slug=prod color=#FF0000
pydomi shell                     # IPython REPL с готовым `api`
```

Все команды читают `DOMI_URL` / `DOMI_TOKEN` из env, либо принимают
`--url` / `--token`.

---

## Контекст-менеджер

```python
with pydomi.Api("http://your-server:8000", token=tk) as api:
    print(api.status())          # {'title': '...', 'version': '...'}
```

---

## Кастомный `requests.Session`

```python
import requests
from requests.adapters import HTTPAdapter
from urllib3.util.retry import Retry

s = requests.Session()
s.mount("https://", HTTPAdapter(max_retries=Retry(total=5)))

api = pydomi.Api("https://srv", token=tk, session=s, timeout=10)
```

---

## Разработка

```bash
pip install -e .[dev,async,docs]
pytest                  # 215+ unit-тестов через responses + respx, без сети
ruff check src tests
cd docs && make html    # Sphinx → docs/_build/html/index.html
```

Структура:

```
src/pydomi/
    api.py            # Api — top-level, sync
    async_api.py      # AsyncApi — same shape, через httpx
    endpoint.py       # CRUD, bulk, OPTIONS metadata, strict validate
    queryset.py       # QuerySet: filter/search/order_by/first/last/iterator
    record.py         # Record: save/update/refresh/diff/delete/describe
    relations.py      # _LazyFK / _M2MManager / _ReverseManager
    tokens.py         # api.tokens.{list,create,rotate,revoke,delete}
    cache.py          # TTL-LRU для GET-detail
    codegen.py        # OpenAPI → models.py + models.pyi + метаданные
    cli.py            # python -m pydomi
    exceptions.py     # типизированная иерархия
    registry.py       # статический app → endpoint map
    generated/        # placeholder; перезаписывается update-classes
examples/
    load_inventory.py            # idempotent get-or-create
    load_inventory_bulk.py       # CSV bulk import
    audit_unassigned.py          # отчёт «без AS / без site / без role»
    tag_devices_by_subnet.py     # тэгнуть устройства внутри CIDR
    async_bulk_export.py         # параллельная выгрузка в JSON
    watch_changelog.py           # poll-er свежих changelog событий
```

---

## Известные ограничения 0.1.0

- **Изменение значения lazy-FK** (например, `dev.site = 5`) ставит правильный
  id в `_data` и при `save()` отправит его, но **кеш `dev.site` Record** не
  инвалидируется до следующего `refresh()`. Workaround: `dev.update(site=5)`.
- **Custom actions с `detail=True`** автоматически не привязываются —
  используйте `api.X.call_action_on(pk, "name", method="POST", json=...)`.
- **Standalone эндпоинты вне ViewSet** (`/api/changelog/`, кастомные `@api_view`)
  доступны через `api.request("GET", "/api/changelog/", params=...)`.
