zone-update 0.6.0

A minimal library of DNS provider utilities
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87

# Zone Update

[![Crates.io](https://img.shields.io/crates/v/zone-update)](https://crates.io/crates/zone-update)
[![Docs.rs](https://docs.rs/zone-update/badge.svg)](https://docs.rs/zone-update)
[![GitHub CI](https://github.com/tarka/zone-update/actions/workflows/tests.yml/badge.svg)](https://github.com/tarka/zone-update/actions)
[![License](https://img.shields.io/crates/l/zone-update)](https://github.com/tarka/zone-update/blob/main/README.md#License)

A minimal Rust library for updating DNS records with various DNS providers.

## Overview

Zone Update is a lightweight library that provides a simple interface for
programmatically managing DNS records through provider APIs.
The library is async and supports both `smol` and `tokio`.

### Supported DNS providers

Currently, Zone Update supports the following DNS providers:

* Gandi
* Dnsimple
* DnsMadeEasy
* Porkbun

See the [DNS providers matrix](docs/PROVIDERS.md) for more details.


## Installation

Add this to your `Cargo.toml`:

```toml
[dependencies]
zone-update = "0.1.0"
```

## Usage

### Basic Example

```rust
use zone_update::{gandi, errors::Result};
use std::net::Ipv4Addr;

async fn update_gandi_record() -> Result<()> {
    let config = zone_update::Config {
        domain: "example.com".to_string(),
        dry_run: false,
    };
    
    let auth = gandi::Auth::ApiKey("your-api-key".to_string());
    let client = gandi::Gandi::new(config, auth);
    
    let host = "www";
    let new_ip = Ipv4Addr::new(192, 0, 2, 1);

    // Update the A record for www.example.com
    client.update_v4_record(host, &new_ip).await?;
    
    Ok(())
}
```

See the `examples` directory for other use-cases.

## Contributing

At this point the most useful contributions would be to add additional DNS
provider APIs. However other contributions are welcome.

## AI Contribution Policy

LLM and related 'AI' technologies can be useful for software development, but
best-practices on their usage are still evolving. For this reason this project
will not accept runtime code generated by AI. Generation of _draft_
documentation and test code is acceptable, but should be reviewed by the
submitter before raising a PR. After all, if you can't be bothered to review it
why should anybody else?

## License

This project is licensed under either of:

- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE-2.0.txt) or http://www.apache.org/licenses/LICENSE-2.0)
- MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)

at your option.