Metadata-Version: 2.4
Name: donazopy
Version: 1.0.17
Summary: A Python CLI tool for DNS and domain-provider management.
Project-URL: Homepage, https://github.com/twardoch/donazopy
Project-URL: Issues, https://github.com/twardoch/donazopy/issues
Author: Adam Twardoch
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.
License-File: LICENSE
Keywords: cli,dns,domains,zonefile
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Internet :: Name Service (DNS)
Classifier: Typing :: Typed
Requires-Python: >=3.12
Requires-Dist: dnspython>=2.6
Requires-Dist: fire>=0.6
Requires-Dist: httpx>=0.27
Requires-Dist: python-dotenv>=1.0
Description-Content-Type: text/markdown

# donazopy

> **Pre-release / pre-alpha.** The command surface changed in this revision (issue 203) — old commands have been removed and replaced with a unified target notation.

`donazopy` is a focused Python CLI for local DNS zone-file work and real provider operations.

Supported workflows:

1. **Local zone files** — validate, normalize, compare two zones as a change summary.
2. **Provider DNS** — load credentials from `.env` or environment, list/export/import records, copy zones between providers, read/assign nameservers, diff a live zone against a file.

Operational providers today: **Cloudflare**, **GoDaddy**, **IONOS**, and **Joker.com (DMAPI)**. Further providers are tracked in `TODO.md`.

## Installation

```bash
uv sync
```

Python 3.12+, Hatch + `hatch-vcs` for git-tag-derived versions.

## Credentials

Credentials are loaded with [`python-dotenv`](https://pypi.org/project/python-dotenv/):

- `donazopy` auto-discovers `.env` from the current working directory.
- Pass an explicit file with `--dotenv-path=path/to/.env`.
- Real environment variables override `.env` values.
- Status output shows presence and source only — secret values are never printed.

Create an ignored `.env` with the credentials for the provider(s) you use:

```dotenv
CLOUDFLARE_DNS_TOKEN=your-token          # Cloudflare (DNS Read for list/export, DNS Edit for import/copy, Zone Edit for create-zone)
CLOUDFLARE_DNS_ACCOUNT=your-account-id    # Cloudflare, optional — only needed for create-zone when the token spans multiple accounts
GODADDY_API_KEY=your-key                 # GoDaddy
GODADDY_API_SECRET=your-secret
IONOS_API_PUBLIC=your-public-prefix      # IONOS (combined as "{public}.{secret}" in the X-API-Key header)
IONOS_API_SECRET=your-secret
JOKER_API_KEY=your-dmapi-api-key         # Joker.com DMAPI
```

Run `donazopy status` to see, per provider, which variables are present and where they came from (values are never printed).

## Target notation

Most commands accept a `TARGET` argument using the notation:

```
[provider/][domain][:record_type][:host_name][:value]
```

| Example | Meaning |
| --- | --- |
| `example.com` | that domain on whichever sole operational provider manages it |
| `cloudflare/example.com` | `example.com` on Cloudflare specifically |
| `cloudflare/*` | all domains on Cloudflare |
| `cloudflare/example.com:A` | A records for `example.com` |
| `cloudflare/example.com:A:www:1.2.3.4` | filtered to a specific host and value |
| `example.com.zone` | a local zone file (resolved by extension / path heuristics) |

`*` in any filter segment means "no filter". A trailing `:TYPE:host:value` tuple is optional and defaults to no filtering.

## Quick start

```bash
# Tool version and operational providers
uv run donazopy version
uv run donazopy providers

# Domains a provider manages
uv run donazopy domains ionos --dotenv-path=.env

# Provider metadata and credential status
uv run donazopy status
uv run donazopy status cloudflare
uv run donazopy status cloudflare/example.com --dotenv-path=.env

# DNS records (with optional record-level filters)
uv run donazopy records cloudflare/example.com --dotenv-path=.env
uv run donazopy records cloudflare/example.com:A --dotenv-path=.env

# Export a live zone as BIND text
uv run donazopy export cloudflare/example.com --dotenv-path=.env
uv run donazopy export cloudflare/example.com --output=example.com.zone --overwrite
uv run donazopy export cloudflare/* --output=zones --dotenv-path=.env   # writes zones/<domain>.zone for every zone --skip-ns

# Import BIND zone text into a provider
uv run donazopy import-zone cloudflare/example.com example.com.zone --dotenv-path=.env
uv run donazopy import-zone cloudflare/example.com example.com.zone --clean --dotenv-path=.env   # wipe target first

# Copy a zone from one provider target to another
uv run donazopy copy cloudflare/example.com cloudflare/example-staging.com --skip-ns
uv run donazopy copy cloudflare/example.com cloudflare/example.com --replace  # wipe dest first
uv run donazopy copy cloudflare/* ionos/ --clean --skip-ns --dotenv-path=.env   # iterate every Cloudflare zone, copy each to IONOS (same name)
uv run donazopy copy ionos/example.com cloudflare/example.com --skip-ns --replace  # migrate IONOS -> Cloudflare (creates the CF zone if missing)

# Create a hosted zone (Cloudflare)
uv run donazopy create-zone cloudflare/example.com --dotenv-path=.env

# Read or assign nameservers
uv run donazopy nameservers cloudflare/example.com --dotenv-path=.env
uv run donazopy nameservers godaddy/* --dotenv-path=.env          # {domain: [nameserver, ...]} for every domain
uv run donazopy nameservers godaddy/example.com ns1.example.net ns2.example.net   # assign (GoDaddy/Joker only)

# Validate and normalize a local zone file
uv run donazopy validate example.com.zone --origin=example.com.
uv run donazopy normalize example.com.zone --origin=example.com.
uv run donazopy normalize example.com.zone --output=normalized.zone --overwrite

# Diff two zones — each side can be a file path or a provider target
uv run donazopy diff before.zone after.zone --origin=example.com.
uv run donazopy diff cloudflare/example.com example.com.zone

# Diagnose a zone (provider target or local file); add --fix to apply safe repairs
uv run donazopy doctor cloudflare/example.com --dotenv-path=.env
uv run donazopy doctor example.com.zone --origin=example.com.
uv run donazopy doctor cloudflare/example.com --fix --dotenv-path=.env
uv run donazopy doctor cloudflare/example.com --json --dotenv-path=.env
uv run donazopy doctor cloudflare/example.com --fix --dmarc-email=ops@dmarc-service.com --dotenv-path=.env
uv run donazopy doctor cloudflare/* --fix --dotenv-path=.env   # diagnose & fix every Cloudflare zone
```

## Command reference

| Command | Description |
| --- | --- |
| `donazopy version` | Print installed version |
| `donazopy providers` | List operational provider keys |
| `donazopy domains PROVIDER [--dotenv-path=PATH]` | List the domains/zones a provider manages (`PROVIDER` may be `ionos` or `ionos/*`) |
| `donazopy status [TARGET] [--dotenv-path=PATH]` | Provider metadata + credential status |
| `donazopy records TARGET [--dotenv-path=PATH]` | List DNS records (target may include record filters) |
| `donazopy export TARGET [--output=PATH] [--overwrite] [--skip-ns] [--skip-types=A,AAAA,...] [--dotenv-path=PATH]` | Export zone as BIND text. Wildcard target (`provider/*`) requires `--output=DIR` and writes each zone to `DIR/<domain>.zone`; for single-domain targets `--output` may be a file or a directory (`DIR/<domain>.zone` is autogenerated). |
| `donazopy import-zone TARGET PATH [--proxied] [--clean] [--dotenv-path=PATH]` | Import BIND zone file into provider; `--clean` wipes existing records first |
| `donazopy create-zone TARGET [--dotenv-path=PATH]` | Create a hosted zone for the domain (Cloudflare; idempotent). Other providers raise "not supported" — the zone exists with the domain. |
| `donazopy copy SOURCE DEST [--skip-ns] [--skip-types=...] [--replace] [--clean] [--create=BOOL] [--dotenv-path=PATH]` | Copy zone between provider targets; by default the destination zone is created if missing (`--create=False` to skip). `--clean` is a synonym for `--replace` (wipe target before copying). Wildcard source (`provider/*`) iterates every zone the source provider manages and copies each to the same-named zone on the destination (use `dest_provider/`). |
| `donazopy nameservers TARGET [NS1 NS2 ...] [--dotenv-path=PATH]` | Read or assign nameservers |
| `donazopy diff A B [--origin=...] [--dotenv-path=PATH]` | Diff two zones (file paths or provider targets) |
| `donazopy validate PATH [--origin=...]` | Validate a local BIND zone file |
| `donazopy normalize PATH [--origin=...] [--output=PATH] [--overwrite]` | Normalize a local BIND zone file |
| `donazopy doctor TARGET [--fix] [--dmarc-email=ADDR] [--json] [--output=PATH] [--overwrite] [--origin=...] [--dotenv-path=PATH]` | Diagnose a zone (provider target or local file) for migration artifacts, TXT duplicates, missing email-security records, and CNAME conflicts; with `--fix`, applies safe repairs and writes a backup. `--dmarc-email=ADDR` plugs `ADDR` into the suggested/applied DMARC `rua=mailto:` and prints the external-destination authorization record when the receiving domain differs from the zone. |

## Provider matrix

| Provider | Status |
| --- | --- |
| Cloudflare | Operational: record listing, BIND export/import, zone copy, nameserver read, credential status. `assign_nameservers` is "not supported" (Cloudflare DNS cannot set registrar delegation). |
| GoDaddy | Operational: domain list, record listing, BIND export, record import (PATCH/append), `delete_all_records`, registrar nameserver read **and** assignment. |
| IONOS | Operational: zone list, record listing, BIND export/import, `delete_all_records`, apex nameserver read. `assign_nameservers` is "not supported" (the IONOS DNS API cannot change registrar delegation). |
| Joker.com (DMAPI) | Operational: domain list, virtual DNS zone export/import (Joker↔BIND), `delete_all_records`, registrar nameserver read **and** assignment. |
| AWS Route 53, Google Cloud DNS, Azure DNS, Namecheap, DNSimple, Gandi, Porkbun, Dynadot, Vercel, DigitalOcean, Hetzner, Linode, Vultr, Hosting.com, Hostinger, Bluehost | Planned only — not exposed until real adapters and tests exist. |

## Safety model

- Zone-file operations are local and deterministic.
- Output writes refuse to overwrite existing files unless `--overwrite` is passed.
- `copy --replace` deletes all destination records before importing; use with care.
- Credentials are loaded through `python-dotenv` and environment variables, then redacted in status output.
- Unsupported providers are not exposed by `donazopy providers`; only providers with a real adapter and tests appear.
- `assign_nameservers` raises a clear "not supported" error on DNS-only delegation surfaces (Cloudflare, IONOS); use a registrar-capable provider (GoDaddy, Joker) to change delegation.

## Documentation

Full docs are built from `src_docs/md/` with MkDocs + ProtoDocs + MaterialX:

```bash
./docs.sh serve   # live preview at http://127.0.0.1:8000
./docs.sh build   # write static output to docs/
```

Config: `mkdocs/mkdocs.yml`. Pre-built output is committed to `docs/`.

## Development commands

```bash
uv sync
uvx hatch test
uvx ruff check .
uvx --with pytest --with dnspython --with fire --with httpx --with python-dotenv pyright src tests
python -m compileall src tests
./build.sh
```

`./build.sh` runs `uvx hatch clean` and `uvx hatch build`. `./publish.sh` runs `uvx hatch clean`, `uvx gitnextver`, `uvx hatch build`, then `uv publish`.

Do not commit provider credentials, `.env`, `.pypirc`, or private research material.
